リクエストパラメータ
APIリクエストのパラメータ
EP-APIでは、URL、HTTPリクエストヘッダ、HTTPリクエストボディのいずれかでパラメータを指定して利用します。
EP-APIで指定できるリクエストパラメータは3種類あります。
- すべてのAPIで共通のパラメータ
- APIごとに指定が異なるパラメータ
- リクエストごとに指定が異なるパラメータ
共通パラメータ
| パラメータ | 指定箇所 | 説明 | 利用可能な値 |
|---|---|---|---|
APIVersion | URL | APIバージョン | 参照: APIの共通仕様 |
| SignatureMethod | HTTPリクエストヘッダ x-iijapi-SignatureMethod | Singature生成に用いるハッシュアルゴリズム | HmacSHA256, HmacSHA1 |
| SignatureVersion | HTTPリクエストヘッダ x-iijapi-SignatureVersion | Signature生成ロジックのバージョン | 2 |
| AccessKeyId | HTTPリクエストヘッダ Authorization | 使用するAccessKey | 参照: AccessKeyとSecretKey |
APIごとに個別のパラメータ
| パラメータ | 指定箇所 | 説明 | 利用可能な値 |
|---|---|---|---|
| API名 | URL | API名称 | 参照: API一覧 |
| APIごとに異なる | URL | 親サービスコードや子サービスコード | 参照: API一覧 |
| APIごとに異なる | HTTPリクエストボディ | JSON形式のAPI個別のパラメータ | 参照: API一覧 |
リクエストごとに個別のパラメータ
| パラメータ | 指定箇所 | 意味 | 利用可能な値 |
|---|---|---|---|
| Expire | HTTPリクエストヘッダ x-iijapi-Expire | Signatureの有効期間 | 書式: YYYY-MM-DDThh:mm:ssZ |
| Signature | HTTPリクエストヘッダ Authorization | 認証・リクエストの署名 | 参照: Signatureの生成方法 |
APIリクエストサンプル
POST /r/[APIVersion]/[個別パラメータ]/[API名].json Host: ep.api.iij.jp Content-MD5: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Content-Type: application/json Date: Mon, 20 Jan 2014 12:34:56 GMT x-iijapi-Expire: [Expire] x-iijapi-SignatureMethod: [SignatureMethod] x-iijapi-SignatureVersion: [SignatureVersion] Authorization: IIJAPI [AccessKeyId]:[Signature] [HTTPリクエストボディ: JSON形式のAPI個別のパラメータ]