Apps APIでエラーが発生した場合のレスポンス形式と、代表的なエラーの見方をまとめます。
HTTPステータス別の共通レスポンス
| HTTPステータス |
内容 |
レスポンス |
| 400 |
リクエストパラメータ不正 |
error 配列、または error_code / error / error_description |
| 404 |
リソースなし |
対象のリソースが見つからない場合に返ります。 |
| 405 |
サポートされないリクエストメソッド |
対象エンドポイントで許可されていないHTTPメソッドを指定した場合に返ります。 |
パラメータ不正のレスポンス例
{
"error": [
{
"param": "エラーが発生したパラメータ名",
"message": "エラー内容"
}
]
}
Errorオブジェクト
| json_key |
json_type |
required |
description |
remarks |
| param |
string |
必須 |
エラーが発生したパラメーター |
|
| message |
string |
必須 |
エラー内容 |
|
エラーコード形式のレスポンス例
{
"error_code": "4003",
"error": "invalid_token",
"error_description": "アクセストークンが不正です"
}
代表的なエラーコード
- 4003:権限エラー(アクセストークン不正など)
- FFFF:その他のエラー
関連情報