エラーレスポンス

GP-APIのエラー

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

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

エンドポイントURLが誤っているなど、GP-APIのリクエストパラメータ以外にエラーの原因がある場合、APIはレスポンスパラメータを返さず、HTTP Status Codeのみを返します。APIを呼び出すクライアントプログラムは、まずHTTP Status Codeを確認し、エラーであることが確認できた場合にレスポンスパラメータの中のErrorType、ErrorMessageを確認するようにして下さい。

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

JSON

{
    "ErrorResponse": {
        "RequestId": "dummy1375674759295",
        "ErrorType": "errortype",
        "ErrorMessage": "errormessage"
    }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse>
  <RequestId>dummy1375674759295</RequestId>
  <ErrorType>errortype</ErrorType>
  <ErrorMessage>errormessage</ErrorMessage>
</ErrorResponse>

レスポンスパラメータ

パラメータ タイプ 意味
ErrorResponse.RequestId String

APIリクエスト毎に割り当てられるユニークなID

ErrorResponse.ErrorType String エラーの原因 (以下の表参照)
ErrorResponse.ErrorMessage String エラー発生原因についての説明

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

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

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

共通エラー

エラー HTTP Status Code ErrorType ErrorMessage 説明 備考
HTTP/1.1以外 505 (なし)   HTTP1.1以外のリクエストを受け付けた レスポンスパラメータは返却されません
URL不正 404 (なし)   エンドポイントURLが正しくない レスポンスパラメータは返却されません
メソッド不正 405 (なし)   指定された以外のHTTP メソッドを利用した レスポンスパラメータは返却されません
Action不正 400 ActionNotFound Specified Action is not found. 存在しないActionが指定された  
APIVersion不正 400 APIVersionNotFound Specified APIVersion is not found. APIVersionパラメータが不正  

認証エラー

(署名検証エラー)

400 BadRequest Signature is not valid. Signatureパラメータが存在しない  
Signature method is not valid. SignatureMethodパラメータが不正  
Signature version is not valid. SignatureVersionパラメータが不正  
Expire is not valid. Expireパラメータが不正  
RequestExpired The request has expired. Expireで指定された期間を過ぎている  
401 AuthFailure Unable to validate the provided access credentials. 指定したAccessKeyが無効  
403 SignatureDoesNotMatch The request signature we calculated does not match the signature you provided. Signatureの値がリクエストの内容と合致しない  
パラメータエラー 400 ParameterError There are invalid parameters. 不正なパラメータが含まれている  
Duplicated parameter found. パラメータが重複している  
200 (個別) (個別) API固有のエラー API固有のエラーの場合、Statusは200となります
システム障害 500 SystemError System error occurred.

GP-API設備のシステム障害

サポートセンターへお問い合わせ下さい
タイムアウト 503 Timeout System is busy. リクエストがタイムアウトしました  
httpでアクセス 403 Required to use https.   必ずhttpsを使用して下さい レスポンスパラメータは返却されません
メンテナンス中 403 StatusError Service is stopping by maintenance. メンテナンス中のためGP-APIを利用できません。