共通リクエストパラメータ¶
この記事では、External API の共通リクエストパラメータについて説明します。
共通リクエストヘッダー(Header)¶
| パラメータ名 | 必須 | 例 | 説明 |
|---|---|---|---|
| Content-Type | リクエストボディがある場合 | application/json | リクエスト内容に一致させます。JSON リクエストでは application/json を使用し、アップロードでは boundary 付きの multipart/form-data を使用します。GET でリクエストボディがない場合は省略できます |
| X-Df-Access-Key | 必須 | e243xxxxxxxx | アクセス元の識別子です。この値は「サービス設定項目」で説明されている accessKey です |
| X-Df-Timestamp | 必須 | 1711701527 | リクエストが開始された時点の秒単位のタイムスタンプです。許容される誤差の絶対値は「サービス設定項目」で説明されている timeliness の値です。この時間範囲を超えると 400 ft.IllegalTimestamp を返します |
| X-Df-SVersion | 設定を推奨 | v20240417 | 以下の例では v20240417 を使用しています。このバージョンを指定しない場合、サーバー側では旧バージョン互換のアルゴリズムが使用されます |
| X-Df-Nonce | 必須 | 5931f3059ba244dxxx | リクエストごとに生成されるランダムな一時値です |
| X-Df-Signature | 必須 | <signature> |
署名結果の値です |
エラー応答については、共通エラー定義を参照してください。