共通エラー応答

400 - Bad Request (不正リクエスト)

リクエストの形式が不適切であったり、不正な値が含まれていたりする場合に返されます。応答本体には、不正なフィールド名とそのタイプ、サービスが受信した値が示されます。このフォーマットは、新しい API のすべてのサービスとメソッドで使用されます。

応答例 

サポート対象外の言語 :

{
  "type": "invalid_input",
  "message": "An invalid request was sent in, please check the nested errors for details.",
  "errors": [
    {
      "type": "language.not_supported",
      "message": "Language is not supported. Supported languages are: [de-DE, en-US, es-ES, es-MX, fr-FR, id-ID, it-IT, ja-JP, ko-KR, pt-BR, zh-CN]",
      "fields": [
        {
          "name": "language",
          "type": "querystring",
          "value": "xx-XX"
        }
      ]
    }
  ]
}

バージョン値が未記入 :

{
  "type": "version.required",
  "message": "You have not specified a version, the supported versions are: [1, 2]",
  "fields": [
    {
      "name": "version",
      "type": "path",
      "value": "missing"
    }
  ]
}

無効なバージョン値 :

{
  "type": "version.unsupported",
  "message": "You have requested a version that is not supported, supported versions are: [1, 2]",
  "fields": [
    {
      "name": "version",
      "type": "path",
      "value": "3"
    }
  ]
}

401 - Unauthorized (無権限)

HTTP 認証ヘッダーを検出できないか解析できない場合に返されます。EAN のすべての API サービスへのリクエストには、API キー + 共有秘密 + UNIX タイムスタンプ (秒) を連結したソルトのない SHA-512 ハッシュが含まれる必要があります。詳細については、シグネチャー認証のページを参照してください。

400 無権限応答の例 :

{
  "type": "request_unauthenticated",
  "message": "Data required to authenticate your request is missing. Ensure that your request follows the guidelines in our documentation."
}

403 - Forbidden (禁止)

HTTP 認証ヘッダーは有効ですが、リクエストされたリソースへのアクセス許可がない場合に返されます。

403 禁止応答の例

{
  "type": "request_unauthenticated",
  "message": "Your request could not be authenticated. Ensure that your request follows the guidelines in our documentation.",
  "fields": [
    {
      "name": "apikey",
      "type": "header",
      "value": "jaj3982k239dka328e"
    },
    {
      "name": "signature",
      "type": "header",
      "value": "129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b"
    },
    {
      "name": "timestamp",
      "type": "header",
      "value": 198284729
    },
    {
      "name": "servertimestamp",
      "type": "server",
      "value": 198284729
    }
  ]
}

404 - Not Found (未検出)

リクエストされた API のリソースが検出できない場合に返されます。EAN の記載例で、リクエストした URL を確認してください。 

Geography API と Content API も、リクエストされた地理やコンテンツ向けのファイルやリソースが検出できない場合に、404 応答を使用します。詳しい例については、それぞれの文書ページを参照してください。

{
    "type": "resource.not_found",
    "message": "The requested resource could not be found."
}

426 - Upgrade Required (アップグレードが必要)

リクエストで TLS (SSL の後継) が使用されていない場合に返されます。

{
  "type": "upgrade_required",
  "message": "This service requires the use of TLS."
}

500 - Internal Server Error (内部サーバー エラー)

EPS の API またはアップストリーム システム内のエラーを返します。リクエストをやり直してください。

{
  "type": "unknown_internal_error",
  "message": "An internal server error has occurred."
}

503 - Service Unavailable (サービス対象外)

リクエストされたサービスに技術的な問題がある場合に返されます。再試行する前の最小遅延 (秒) を示す Retry-After ヘッダーが含まれる場合があります。

{
  "type": "service_unavailable",
  "message": "This service is currently unavailable."
}