CAC-APIの利用方法

CAC-APIは、URLとHTTPリクエストヘッダ、HTTPリクエストボディでパラメータを指定して利用します。お客様が作成されたクライアントプログラムから、以下の要領で、アクセスURLに対してリクエストしてください。

• httpでのリクエストは受け付けません。必ずhttpsを使用してください。APIを呼び出すプログラムは、リクエスト先が正当なものであることを確認するため、SSL証明書を検証することを推奨いたします。
• 短期間に極めて多数のAPIリクエストが行われた場合、サービスの健全性を保つためにAPIのリクエストを制限する場合があります。

APIリクエスト時のパラメータ

CAC-APIでは、パラメータをリクエストのURLやHTTPリクエストで指定します。CAC-APIで指定するパラメータは以下のとおりです。

• 共通/個別: パラメータの区分け
  • 共通: すべてのAPIで共通のパラメータ
  • API個別: APIごとに指定が異なるパラメータ
  • リクエスト個別: リクエストごとに指定が異なるパラメータ
• 指定方法: 共通パラメータの指定方法
• パラメータ: 共通パラメータの名称
• URL: リクエストのURL
• HTTPヘッダ: HTTPリクエストヘッダ
• HTTPボディ: HTTPリクエストボディ
• 意味: 共通パラメータの意味

リクエスト

各パラメータは以下のように、URLまたはHTTPリクエストで指定します。

• URLに指定する個別パラメータは、個別パラメータが必要なAPIの場合にのみ指定します。

PUT /r/(APIVersion)/(ServiceCode)/(個別パラメータ)/(API名).json
Host: cac.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個別のパラメータ)

レスポンスパラメータ

APIから返されるレスポンスには、すべてのAPIに共通のフィールドと、API毎に定義される個別のフィールドがあります。

以下に共通のフィールドを示します。

• 個別のパラメータはAPI一覧を参照してください