NiceNIC ドメインAPI v2 ドキュメント & クイックスタート
NiceNIC ドメインAPI v2 は、マーケットアカウントおよびリセラーアカウントの両方で利用できます。この概要では、アクセスの設定、最初のリクエストの確認、APIレスポンスモデルの理解、左側のナビゲーション内の該当セクションへの直接移動ができます。
マーケットアカウント: マーケットアカウント価格でのAPIアクセス。
リセラーアカウント: 現在のリセラーティアに割り当てられた価格でのAPIアクセス。
リセラーレベルと価格を比較 →
本番移行前に統合をテスト
NiceNIC APIサンドボックスを使用して、本番環境に移行する前にドメインAPI統合をテストできます。専用のテスト環境で、認証、APIリクエスト、レスポンス処理、アプリケーションのワークフローを検証できます。
API統合を準備中のリセラー、ホスティングプロバイダー、開発者、プラットフォームに最適です。
4つのステップで最初のAPIコールを実行する
本番の登録・更新・移管を有効にする前に、まず読み取り専用のリクエストから始めてください。これにより、有料注文を行わずに認証、リクエスト形式、レスポンス処理を検証できます。
APIアクセスを有効にする
API設定を開き、APIシークレットを作成または取得し、該当する場合は承認済みサーバーIPを構成してください。
認証の確認
HTTPS を使用し、Authorization ヘッダーを username:api_secret の形式で指定してください。
安全なテストを実行する
まずはドメインの空き状況、料金、アカウント残高、ドメイン一覧から始めてください。
レスポンスの処理
有料の本番運用を有効にする前に、返されたcodeとmsgを読み取って保存してください。
推奨される最初のリクエスト: ドメインの空き状況確認
空き状況確認エンドポイントは、ドメイン名をカンマで区切ることで、単一のリクエストで複数のドメインをサポートします。
必要なワークフローを選択
以下の概要は左側のナビゲーションに対応しています。適切なワークフローを特定し、専用のエンドポイントページでパラメータ、リクエスト例、レスポンス例を確認してください。
| セクション | 用途 | ドキュメント記載の機能 |
|---|---|---|
| はじめに | 安全に接続し、レスポンスの処理方法を理解します。 | API概要、APIサンドボックス、認証、レスポンスコード。 |
| ドメイン管理 | 主要なドメインライフサイクルを自動化します。 | 空き状況確認、ドメイン一覧、ドメイン詳細、登録、更新、移管、ネームサーバー、連絡先、料金。 |
| 不正利用 & コンプライアンス | コンプライアンス上の注意が必要なドメインを監視します。 | 不正利用報告のあるドメインを一覧表示し、機械可読な不正利用ステータス、保留ライフサイクル、苦情情報、推奨される対応を取得します。 |
| DNSレコード | ホストされたDNSレコードをプログラムから管理できます。 | DNSレコードの一覧表示、作成、更新、削除ができます。 |
| 子ネームサーバー | 自身のドメイン配下のネームサーバーに関するホストレコード / グルーレコードを管理できます。 | 子ネームサーバーの作成、一覧表示、更新、削除ができます。 |
| アカウントと請求 | アカウントレベルの確認に自動化を連携できます。 | アカウント残高と取引関連のアカウント情報。 |
| WHMCS API | NiceNICを既存のWHMCS請求ワークフローに統合できます。 | 空き状況、登録、更新、移管、ドメイン詳細、ネームサーバー、連絡先、およびその他のレジストラモジュール機能。 |
| APIに関するよくある質問 | アクセス、セキュリティ、テスト、ワークフローに関する一般的な疑問を解決します。 | 利用資格、認証情報、リクエスト処理、サポートされている操作、および統合ガイダンス |
推奨される最初の統合手順
信頼性の高い本番統合では、実際の顧客注文を送信し始める前に、アクセス権限と購入条件を検証する必要があります。
APIシークレット + 許可されたIP
読み取り専用の接続テスト
現在のアカウントレベル料金を照会
有料操作に必要な資金を確認
コードとメッセージを処理
登録 / 更新 / 移管
成功・保留・エラー応答について
code: 0 — 成功応答 現在のエンドポイントの例では、正常に完了した応答にコード 0 を使用しています。
code: 201 — 保留中の注文 登録および移管のドキュメントでは、注文が送信されたものの最終処理がまだ保留中の場合にコード 201 を返すことがあります。
code: 400 — リクエストエラー エンドポイントの例では、リクエストパラメータのエラーにコード 400 を使用しています。
登録保留中の動作
ドメイン登録に関して、現在のドキュメントでは、201応答は注文が正常に送信され、料金が差し引かれたことを意味しますが、最終的なアクティベーションはレジストリの確認待ちであると記載されています。ドメインを有効化できない場合、登録料金は24時間以内にNiceNICアカウントの残高に返金されます。
移管保留中の動作
移管エンドポイントは、201 が保留中の注文であることも文書化しています。したがって、アプリケーションでは、保留中の移管を、移管がすでに完了した証拠ではなく、処理として受け付けられたものと見なす必要があります。
有料操作の前に料金を照会する
NiceNICの料金エンドポイントを使用すると、ドメインの登録料金、更新料金、移転料金を取得できます。仕様に記載されているtypeの値は、register、renew、transfer、allです。仕様に記載されている期間は1~10年で、TLD固有の例外が発生する場合があります。
登録料金のレスポンスでは、is_premiumフラグも返される場合があります。アプリケーションが現在のアカウントレベルでの費用を把握する必要がある場合は、有料リクエストを送信する前に料金エンドポイントを使用してください。
ネームサーバー、DNSレコード、子ネームサーバーの違いを理解する
| 操作 | 使用するケース | ドキュメントに記載された機能 |
|---|---|---|
| ネームサーバーの更新 | ドメインを別の権威ネームサーバーに委任したい場合。 | ドメインのネームサーバーエンドポイントは、プライマリ、セカンダリ、および追加のネームサーバーをサポートしており、このページでは上限が六つまでと記載されています。 |
| DNSレコード | NiceNIC DNSホスティングをご利用中で、ゾーンレコードを管理する必要があります。 | DNSレコードの一覧表示、作成、更新、削除には、それぞれ別のAPIが文書化されています。 |
| 子ネームサーバー | ns1.example.com のようなホスト/グルーレコードが必要です。 |
子ネームサーバーの作成、一覧表示、更新、削除を行います。作成エンドポイントでは、ネームサーバーのホスト名がドメインと一致している必要があり、IPアドレスを受け付けます。 |
ドメイン注文だけでなく、ポートフォリオ監視も自動化
ドメインAPI v2 には、登録後に役立つ読み取り操作も含まれています。ドメイン一覧取得エンドポイントは、ページネーション、並べ替え、ステータスフィルタリング、ホールドフィルタリングに対応しています。一方、ドメイン詳細取得では、登録日、有効期限、ネームサーバー、登録者連絡先情報を返します。
不正使用・コンプライアンス監視
NiceNICの不正使用・コンプライアンスAPIは、不正使用レポートのあるドメインを一覧表示し、特定のドメインに関する詳細な機械可読形式の概要を返します。詳細な不正使用エンドポイントでは、Normal、Under Review、Pending ClientHold、ClientHold、Closed、ServerHoldという六種類のドメインレベルステータスフレーズが定義されています。
レスポンスには、現在の影響、推奨される次の対応、保留状態とタイムライン、苦情件数、苦情の日付、カテゴリ、DNS不正使用の分類、証拠の状態、該当する場合は報告されたURLを含めることができます。これにより、プラットフォームやリセラーは、手動レビューだけに頼るのではなく、自社の運用システム内でコンプライアンス状況を表示できるようになります。
システムに合った統合モデルをお選びください
| オプション | 最適な用途 | 現在のドキュメントが提供する内容 |
|---|---|---|
| ドメインAPI v2 | カスタムウェブサイト、SaaSプラットフォーム、内部システム、カスタム請求またはプロビジョニングワークフロー。 | ドメイン、DNS、子ネームサーバー、アカウント、およびコンプライアンス操作にわたる直接のHTTPS + JSON統合。 |
| WHMCSモジュール | すでにWHMCSを利用しているホスティング企業およびリセラー。 | 空き状況、登録、更新、移管、ドメイン詳細、ネームサーバー、連絡先、ロック/アンロック、EPP取得、エラーログ、オプションのテストモード。 |
現在のWHMCSドキュメントでは、要件としてWHMCS 7.0以上、cURL対応のPHP 7.0以上、有効なNiceNIC API認証情報、SSL/TLSサポートが挙げられています。
APIリクエストが失敗した場合
同じ有料操作を繰り返し再試行するのではなく、まず返されたレスポンスと設定状態から確認してください。
認証エラーまたはアクセスエラー
- NiceNIC のユーザー名と API シークレットを確認してください。
- Authorization ヘッダーが存在し、正しい形式であることを確認してください。
- API シークレットがリセットまたはローテーションされていないことを確認してください。
- IP 制限が有効になっている場合は、リクエストが許可された送信元サーバーの IP から送信されていることを確認してください。
リクエストパラメータエラー
- リクエストを、各エンドポイントのドキュメントに記載されているパラメータと比較してください。
- 必須の値、形式、アクション名を確認してください。
- 該当する場合は、TLD固有の登録期間や連絡先情報の要件を確認してください。
有料操作はすぐには完了しません
- 返された
codeとmsgを確認してください。 201の保留応答を最終的な完了と見なさないでください。- 有料操作を再試行する前に、アカウント残高と現在の料金を確認してください。
NiceNICサポートが必要な場合
- リクエストのタイムスタンプとAPIアクションを記録してください。
- 該当する場合は、関連するドメイン名またはオブジェクトを含めてください。
- 返されたコードとメッセージを含めてください。
- 機密性の低いパラメータのみを共有し、APIシークレット全体をチケットに記載しないでください。
安全なテストリクエストから始める
APIアクセスを有効にし、認証を確認し、空き状況または価格照会のリクエストを実行して、顧客向け有料運用を開始する前にレスポンス処理を検証してください。






