【API連携の方法】ドメイン検索&登録バリュードメイン実践編

2021年11月22日2023年12月18日Staff Note

こんにちは、バリュードメイン開発部のSです。

今回はバリュードメインで提供しているAPIを使って、「ドメイン検索と登録」についてお伝えしたいと思います。
APIとは、異なるソフトウェアやアプリケーションが通信や連携をするための「接続のルールや方法」です。

「APIとは？」がまだピンと来ていない方も
「バリュードメインの機能を、Google Chrome等のブラウザを使わずに利用できる方法」
のように認識してもらえれば大丈夫です。

一応バリュードメインAPIのリファレンスも貼っておきます。
https://www.value-domain.com/api/doc/domain
今は見なくても問題ありません。

今回は例として、APIを利用してドメインを取得してみたいと思います。
必要手順は

APIキーの準備
ドメインを検索
ドメインを登録

の３つになります。
バリュードメインの画面に沿って、APIキーの使い方を書いていきます。
お得情報も紹介しますので、ぜひ最後までご覧ください。

1. APIとは
2. APIキーの準備
3. APIでドメイン検索
4. APIでドメイン登録
5. APIお得情報

APIとは

API（Application Programming Interface）は、ソフトウェア間の通信や情報のやり取りをするための「接続のルールや方法」です。

APIをレストランに例えると下記になります。

キッチンは「システムやデータベース」
メニューは「API」
ウェイターやウェイトレスは「APIを通じて指示や情報を伝える方法」

レストランのキッチンに直接入って、料理を自分で作ることはできません。その代わりに、ウェイターやウェイトレスがメニューを持ってきてそのメニューからどんな料理が提供されているか知ることができます。
注文することで食べたい料理を食べることができます。レストランのメニューがAPIの役割にあたります。

APIは、ソフトウェアの「メニュー」のように、どんな機能やデータにアクセスできるかを示し、それらをどのように利用するかの指示を提供します。
この「接続のルールや方法」に従うことで、異なるシステムやアプリ間でスムーズに情報交換や機能の連携が可能になります。

APIキーの準備

APIを使うには、APIキーというパスワードのようなものが必要です。
APIキーの準備は一度だけで、一度作成すると今後は同じAPIキーを使えます。
作り方はとても簡単！手順をご紹介します。
※バリュードメインにログインしている事が前提になります。

バリュードメインのAPI公開ページにアクセス
https://www.value-domain.com/service/api/
トップ画面に表示される「今すぐ利用してみる」にアクセス
遷移後、トップ画面に「API KEYの発行」というボタンがあるのでクリック
ボタンをクリックするとAPIキーが表示されます。大事に保管して下さい。

※このAPIキーが他者に知られてしまった場合、ログイン情報を流出してしまったものと考えて下さい。
　仮にAPIキーが流出してしまった場合は、必ず「APIキーの再発行」を行って下さい。以前のAPIキーは使えなくなります。

APIでドメイン検索

普段バリュードメインでドメインを検索する場合、
https://www.value-domain.com/searchdomain.php

のドメイン検索画面から検索すると思います。

なんとAPIを使うと、お手持ちの端末でコンソールが使える場合

curl "https://api.value-domain.com/v1/domainsearch?domainnames=example-test.com"

この一行を実行するだけで空き状況が返ってきます。

{
"results": [
{
"domainname": "example-test.com",
"sld": "example-test",
"tld": "com",
"status": "211 Domain name not available"
}
],
"request_id": "202111101722050807150000000V",
"request": {
"path": "/v1/domainsearch",
"method": "GET",
"params": {
"domainnames": "example-test.com"
}
}
}

domainnames= のあとを自由に書き換えて実行してみて下さい。

status":"210 Domain name availablea　

のレスポンスがあれば空いている、

status":"211 Domain name not available

のレスポンスがあれば空いていない
という事になります。

またこのドメイン検索のAPIについては、手順０のAPIキーが不要です。
登録不要でどなたでもご利用できます。

APIでドメイン登録

上の手順で取得したいドメインが確認できましたね。
次にドメインの登録を行います。
通常であればバリュードメインでドメインを検索後、
・登録年数の設定
・whois情報の設定
の確認画面から、登録ボタンを押して登録完了という流れです。

画像ではキャンペーン割引中の表示がありますが、安心して下さい。
APIでドメインを取得しても、キャンペーンは適用されます。

それでは下記で、example.comというドメインをAPIを使って取得する場合のコマンドを記載します。
注意事項も記載しますので、必ず一読下さい。

※1.APIキーはBeararの所を書き換える必要があります。
※2.whois情報は弊社のwhois代行情報を記載しています。
※3.実際に取得するドメインは「sld」と「tld」で設定します。
今回はサンプルで sld=example,tld=com とし、example.comを指定しています。
example.comはすでに取得されているので、取得できません。
※4.下記サンプルから、APIキーをご自身の情報に変更し、まだ取得されていないsldとtldを入力して実行すると、
　実際にドメインを取得し、費用が発生してしまうためご注意下さい。
確認も無しに取得！？と思ってしまうかもしれませんが、APIとはそういうものなのです。

参考：https://www.value-domain.com/api/doc/domain/#operation/postDomains

curl -XPOST -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXX" -d '{ "registrar" : "GMO", "sld":"example", "tld":"com", "years" : 1, "ns" : [ "ns1.value-domain.com", "ns2.value-domain.com", "ns3.value-domain.com", "ns4.value-domain.com", "ns5.value-domain.com" ], "whois_proxy" : 1, "contact": { "registrant": { "firstname": "Taro", "lastname": "Yamada", "organization": "personal", "country": "JP", "postalcode": "530-0011", "state": "Osaka", "city": "Osaka-shi Kita-ku", "address1": "3-1 Ofuka-cho nomo", "address2": "Grand Front Osaka Tower B 23F", "email": "[email protected]", "phone": "+81.676342727", "fax": "+81.676342728" }, "admin": { "firstname": "taro", "lastname": "yamada", "organization": "personal", "country": "JP", "postalcode": "530-0011", "state": "Osaka", "city": "Osaka-shi Kita-ku", "address1": "3-1 Ofuka-cho", "address2": "Grand Front Osaka Tower B 23F", "email": "[email protected]", "phone": "+81.676342727", "fax": "+81.676342728" }, "tech": { "firstname": "taro", "lastname": "yamada", "organization": "personal", "country": "JP", "postalcode": "530-0011", "state": "Osaka", "city": "Osaka-shi Kita-ku", "address1": "3-1 Ofuka-cho", "address2": "Grand Front Osaka Tower B 23F", "email": "[email protected]", "phone": "+81.676342727", "fax": "+81.676342728" }, "billing": { "firstname": "taro", "lastname": "yamada", "organization": "personal", "country": "JP", "postalcode": "530-0011", "state": "Osaka", "city": "Osaka-shi Kita-ku", "address1": "3-1 Ofuka-cho", "address2": "Grand Front Osaka Tower B 23F", "email": "[email protected]", "phone": "+81.676342727", "fax": "+81.676342728" } } }' https://api.value-domain.com/v1/domains/

しかしこれはちょっと長いですね(^^;
ドメインの登録には登録者情報や支払い者情報といった情報が必須で、
全て送る必要があります。
こちら値が多いのでコマンドは長いのですが、一度システムとして作り上げてしまうと今後楽に登録する事が可能です。

なので、１個だけドメインを取りたい！
という方は無理やりAPIを使う必要はありません。
ただ、APIを利用することによって自動化や簡素化がしやすいという事を覚えておいてもらえたら、このブログを書いた身としては満足です(^^

またAPIはドメイン検索、登録だけではなく、バリュードメインでできる事はほとんどAPIで行えます。
是非ご興味ある方は、一度APIリファレンスを見ていただき、気になるAPIを使ってもらえたら嬉しい限りです！！
https://www.value-domain.com/api/doc/domain

APIお得情報

最後に少しお得情報を・・・

APIを使ってドメインを取得/更新すると、割引があります。
詳しくは
https://www.value-domain.com/service/api/
のページ下部を確認してみてください。

今後も便利なAPIの使い方をご紹介したいと思いますので、ぜひお楽しみに！

▽キャンペーン開催中！

バリュードメインでは、

【 .com /.net /org: 750円 .info /.biz: 100円 .co.jp: 2,000円】の春の応援SALE、 ドメイン・サーバー同時契約でドメイン更新費用永久無料（年間最大3,124円お得）

などお得な特典やキャンペーンが盛りだくさん！是非、お得なこの機会にご利用ください。最新のキャンペーンはこちらから

▽キャンペーン開催中！

コアサーバーV2サーバーでは、

ドメインとサーバーの同時申し込みで初期費用無料＆ドメインの更新費が永年無料（年間最大3,124円お得）になるサーバーセット割特典、

期間限定のV2サーバー20％OFF（月額312円～）キャンペーン

を実施中です。

是非、お得なこの機会にご利用ください！最新のキャンペーンはこちらから

Posted by admin-dev