EP-APIのエラー

EP-APIのリクエストでエラーが発生した場合、APIは以下の方法でクライアントプログラムにエラーを通知します。

1. HTTP Status Code
2. レスポンスボディ (JSON)

エンドポイントURLが誤っているなど、EP-APIのリクエストパラメータ以外にエラーの原因がある場合、APIはレスポンスパラメータを返さず、HTTP Status Codeのみを返します。

APIを呼び出すクライアントプログラムは、まずHTTP Status Codeを確認し、エラーであることが確認できた場合にレスポンスパラメータの中のErrorTypeやErrorMessage、ErrorDetailを確認するようにしてください。

エラー発生時のレスポンス形式

{

    "ErrorResponse": {

        "RequestId": "xxxxxxxxxxxxxxxxxx",

        "ErrorType": "errortype",

        "ErrorMessage": "errormessage",

        "ErrorDetail": {...}

    }

}

レスポンスパラメータ

エラーが発生した場合の対応

APIリクエスト時にエラーが発生した場合、APIを呼び出したプログラムが適切に処理を行う必要があります。

システムエラーが発生し、時間が経ってもエラーが回復しない場合は弊社サポートセンターにお問い合わせください。

 共通エラー