注意事項
1. ベースURL
| 環境 | アドレス |
|---|---|
| 本番環境 | https://openapi.fastmoss.com |
2. リクエストメソッド
すべてのAPIリクエストは POST メソッドを使用します。
3. レスポンス形式
すべてのAPIレスポンスは JSON object 形式で返されます。data フィールドには具体的なデータが含まれ、Json object です。
| パラメータ名 | 型 | 説明 |
|---|---|---|
code | integer | ステータスコード |
msg | string | メッセージ |
data | object | データ |
request_id | string | リクエストID |
timestamp | timestamp[integer] | サーバータイムスタンプ |
例
json
{
"code": 0,
"msg": "success",
"data": {
"xxx": "xxx"
},
"request_id": "xxxx",
"timestamp": 1690351112
}4. HTTPステータスコード と Code の関係
HTTPステータスコードとCodeは競合しません。Codeは特定のビジネスステータスコードを表します。- 最初に
HTTPステータスコードを確認し、次にCodeを確認してください。 HTTPステータスコードが200でCodeが0の場合、成功を示します。
ステータスコードの説明
| ステータスコード | タイプ | 説明 |
|---|---|---|
0 | 例外なし | 成功 |
10001 | パラメータエラー | パラメータが要件を満たしていません |
20001 | データエラー | リソースが見つかりません |
30001 | パーミッションエラー | アクセス権限がありません |
30002 | パーミッションエラー | データ制限を超えました |
30003 | パーミッションエラー | アクセス頻度制限を超えました |
40001 | サービスエラー | サービス例外が発生しました |