API利用方法

DOMAIN-APIの利用方法

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

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

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

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

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

HTTPメソッド

HTTPメソッド

  • 「GET」、「PUT」、「POST」、または「DELETE」を入力します
共通URL

APIVersion

APIバージョン

  • 詳しくは、「API一覧」をご覧ください
共通URL/HTTPボディDjServiceCode

汎用JP型ドメイン管理サービスのサービスコード

共通URLDgjServiceCode

gTLD型ドメイン管理サービスのサービスコード

共通URLDomainServiceCode

汎用JP型ドメイン管理サービス/gTLD型ドメイン管理サービスのいずれかのサービスコード

API個別URL個別パラメータ

API個別のパラメータ

  • 詳しくは、「API一覧」をご覧ください
API個別URLAPI名

API名称

  • 詳しくは、「API一覧」をご覧ください
API個別URLサブAPI名

サブAPI名称

  • 詳しくは、「API一覧」をご覧ください
リクエスト個別HTTPヘッダExpire

Signatureの有効期間(YYYY-MMDDThh:mm:ssZ)

  • APIリクエストの発行から24時間未満の値が指定できます
共通HTTPヘッダSignatureMethod

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

  • 「HmacSHA256」または「HmacSHA1」を入力します
共通HTTPヘッダSignatureVersion

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

  • 「2」を入力します
共通HTTPヘッダAccessKeyId

使用するアクセスキー

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

認証・リクエストの署名

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

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

  • 詳しくは、「API一覧」をご覧ください
リクエスト

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

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

 

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