コンテンツへスキップ
Last updated

共通応答フォーマット

すべての MoreLogin API 応答は標準の JSON 形式に従います。


応答構造

{
  "code": 0,
  "msg": null,
  "data": {},
  "requestId": "unique-request-id"
}
フィールドタイプ説明
codeinteger結果コード。 0 = 成功、その他の値はエラーを示します
msg文字列| nullエラーメッセージ。成功時は null
dataオブジェクト| 配列 | null応答ペイロード。構造はエンドポイントによって異なります
requestIdstring一意のリクエスト識別子。サポートに連絡するときにこれを含めてください

成功の応答

{
  "code": 0,
  "msg": null,
  "data": {
    "id": 1234567890
  },
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

エラー応答

{
  "code": 99001,
  "msg": "Invalid parameters",
  "data": null,
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

ページ分割された応答

リスト エンドポイントは、次の形式でページ分割されたデータを返します。

{
  "code": 0,
  "msg": null,
  "data": {
    "total": 100,
    "current": 1,
    "pages": 10,
    "dataList": [
      { ... },
      { ... }
    ]
  },
  "requestId": "..."
}
フィールド説明
total総レコード数
current現在のページ番号
pages総ページ数
dataList現在のページのレコードの配列

HTTPステータスコード

ステータス説明
200リクエストは正常に処理されました (ビジネス結果については code フィールドを確認してください)
401未承認 - 無効または期限切れのアクセス トークン
403禁止 — 権限が不十分です
429リクエストが多すぎます - レート制限を超えました
500内部サーバー エラー — サポートにお問い合わせください

ヒント: HTTP ステータス コードだけでなく、応答本文の code フィールドを常に確認してください。 200 HTTP ステータスと code: 99001 は、リクエストは受信されたが検証に失敗したことを意味します。