APIのエラーレスポンスについて｜ソフト・アプリ開発のAPIなら【gooラボ】

APIのエラーレスポンスについて

APIのエラーレスポンスは下記レスポンスフォーマットに従い返却され、エラー種別ごとに内容が異なります。
レスポンスフォーマット、レスポンス詳細は下記の通りです。
※2019年7月23日以降のエラー表記となります。

{"error": {"code": <HTTPステータスコード>, "message": <エラーメッセージ>}}

{"error": {"code": 400, "message": "Invalid JSON"}}

HTTPステータスコード	エラーメッセージ	説明
400	Content-Type is empty	Content-Typeが空だった。
	Invalid JSON	Content-Typeにapplication/jsonが指定されており、JSONのパースに失敗した。
	Invalid Content-Type	Content-Typeがapplication/jsonまたはapplication/x-www-form-urlencodedでなかった。
	Invalid request parameter	APIで定義されたリクエストパラメータに合致していなかった。
	Suspended app_id	app_idが凍結されていた。
	Invalid app_id	app_idが誤っていた。
	Rate limit exceeded	app_idが利用上限（3,000 call/日）を超えていた。
404	Not found: <パス>	APIエンドポイントURLが誤っていた。
405	Method not allowed.	リクエストメソッドがPOSTでなかった。
413	Request to large	リクエストボディが利用上限（102400 bytes）を超えていた。
500	Internal Server Error	APIで障害が発生した。

なお、上記のエラーレスポンスは以下APIで共通です。