バリュードメインAPIドキュメント (1.0.0)

Download OpenAPI specification:Download

概要

このAPIを使用することで、お客様のシステムからバリュードメインの機能を利用することができます。

API認証

このAPIはBearer認証で保護されています。予めトークンを発行しAuthorizationヘッダーに付与してAPIを利用いたします。

Authorization: Bearer <token>

APIの利用

エンドポイント:https://api.value-domain.com/v1/

HTTPプロトコルのGET,POST,PUT,DELETEメソッドでレスポンスを送信します。

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

ドメイン

ドメイン 情報(一覧)取得・新規作成・変更・削除

ドメインの情報一覧取得

リクエスト

GET /domains

概要

アカウントで管理しているドメインの情報一覧取得

Authorizations:
query Parameters
limit
integer

取得件数

page
integer

ページ番号

order
string

並び順
ASC/DESC

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains

API本番用

https://api.value-domain.com/v1/domains

Request samples

Copy
$apikey = 'Your APIKEY';

$url = "https://api.value-domain.com/v1";
$path = "/domains";
$method = "GET";
$postfields = array();
$post_query = json_encode($postfields);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . $path);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
if ($method!=='GET') {
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, $post_query);
  curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);//FIXME use http version 1.1
}
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 120);

$headers = array();
$headers[] = "Content-Type: application/json";
if ($method!=='GET') {
  $headers[] = 'Content-Length: ' . strlen($post_query);
}
$headers[] = 'Authorization: Bearer ' . $apikey;
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
if (curl_errno($ch)) {
  echo 'Connection Error: ' . curl_errno($ch) . ' - ' . curl_error($ch);exit;
}
$info = curl_getinfo($ch);

curl_close($ch);

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "paging":
    {
    },
  • "results":
    [
    ],
  • "request_id": "20190502412345678"
}

ドメインの新規登録

リクエスト

POST /domains

概要

ドメイン名を登録し、ネームサーバと担当者情報の割り当てを行う

Authorizations:
Request Body schema: application/json

ドメイン情報

registrar
string
Default: "GMO"

レジストラ
'GMO'のみ対応しています
(e.g. GMO)

sld
required
string

セカンドレベルドメイン
ご希望のドメイン名を指定します
(e.g. example)

tld
required
string

トップレベルドメイン
ご希望のドメイン名を指定します
(e.g. com)

years
integer

登録年数
複数年指定することができます
1〜10年
(e.g. 1)

ns
Array of strings

ネームサーバー名
ネームサーバーを指定します
(e.g. ['ns1.value-domain.com, ns2.value-domain.com'])

whois_proxy
integer

Whois代行設定
Whois情報を弊社の代理名義にします
1:する, 0:しない
(e.g. 1)

contact
object

登録者情報(アルファベット)
registrant : 登録者情報
admin : 管理担当者情報
tech : 技術担当者情報
billing : 経理担当者情報

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

post /domains

API本番用

https://api.value-domain.com/v1/domains

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "registrar": "GMO",
  • "sld": "string",
  • "tld": "string",
  • "years": 1,
  • "ns":
    [
    ],
  • "whois_proxy": 1,
  • "contact":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    {
    },
  • "request_id": "20190502412345678"
}

ドメインの情報取得

リクエスト

GET /domains/{domain}

概要

アカウントで管理しているドメインの情報取得

※ domainは「登録済みドメインの一覧取得API」から取得します

domainId と domainNameのどちらでも可

Authorizations:
path Parameters
domain
required
string

「登録済みドメインの一覧の取得」APIから取得
ドメインIDとドメイン名のどちらでも指定可能

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

500

Internal Server Error

503

Service Unavailable

504

Gateway Time-out

get /domains/{domain}

API本番用

https://api.value-domain.com/v1/domains/{domain}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    {