Skip to content

注意事項

1. ベースURL

環境アドレス
本番環境https://openapi.fastmoss.com

2. リクエストメソッド

すべてのAPIリクエストは POST メソッドを使用します。

3. レスポンス形式

すべてのAPIレスポンスは JSON object 形式で返されます。data フィールドには具体的なデータが含まれ、Json object です。

パラメータ名説明
codeintegerステータスコード
msgstringメッセージ
dataobjectデータ
request_idstringリクエストID
timestamptimestamp[integer]サーバータイムスタンプ

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "xxx": "xxx"
    },
    "request_id": "xxxx",
    "timestamp": 1690351112
}

4. HTTPステータスコードCode の関係

  • HTTPステータスコードCode は競合しません。
  • Code は特定のビジネスステータスコードを表します。
  • 最初に HTTPステータスコード を確認し、次に Code を確認してください。
  • HTTPステータスコード200Code0 の場合、成功を示します。

ステータスコードの説明

ステータスコードタイプ説明
0例外なし成功
10001パラメータエラーパラメータが要件を満たしていません
20001データエラーリソースが見つかりません
30001パーミッションエラーアクセス権限がありません
30002パーミッションエラーデータ制限を超えました
30003パーミッションエラーアクセス頻度制限を超えました
40001サービスエラーサービス例外が発生しました