API利用方法

DO-APIの利用方法

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

項目規格
プロトコルHTTP/1.1 (https)
HTTPメソッドGET、PUT、POST、DELETEのいずれか
レスポンスフォーマットJSON
文字コードUTF-8
タイムアウト600秒
アクセスドメインdo.api.iij.jp
  • httpでのリクエストは受け付けません。必ずhttpsを使用してください。APIを呼び出すプログラムは、リクエスト先が正当なものであることを確認するため、SSL証明書を検証することを推奨いたします。
  • 短期間に極めて多数のAPIリクエストが行われた場合、サービスの健全性を保つためにAPIのリクエストを制限する場合があります。

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

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

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

HTTPメソッド

HTTPメソッド

値: GET, PUT, POST, DELETE

共通URL

APIVersion

APIバージョン

参照: API一覧

共通URLDoServiceCode

DOサービスコード

参照: サービスコード

API個別URL個別パラメータ

API個別のパラメータ

参照: API一覧

API個別URLAPI名

API名称

参照: API一覧

API個別URLサブAPI名

サブAPI名称

参照: API一覧 

リクエスト個別HTTPヘッダExpire

Signatureの有効期間(UTC)
APIリクエストの発行から24時間未満の値が指定可能

書式: YYYY-MM-DDThh:mm:ssZ

共通HTTPヘッダSignatureMethod

Singature生成に用いるハッシュアルゴリズム 

値: HmacSHA256, HmacSHA1

共通HTTPヘッダSignatureVersion

Signature生成ロジックのバージョン

値: 2

共通HTTPヘッダAccessKeyId

使用するAccessKey

参照: AccessKey

リクエスト個別HTTPヘッダSignature

認証・リクエストの署名

参照: 認証・リクエストの署名

API個別HTTPボディAPIごとに異なる

JSON形式のAPI個別のパラメータ

参照: API一覧

リクエスト

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

  • URLに指定する個別パラメータは、個別パラメータが必要なAPIの場合にのみ指定します。
  • APIによっては、API名のあとにも個別パラメータを指定する場合があります。

 

(HTTPメソッド) /r/(APIVersion)/(DoServiceCode)/(個別パラメータ)/(API名).json
Host: do.api.iij.jp
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個別のパラメータ)