Ry.hk Ry.hk

API

一度にページごとではなく、プログラムからドメインを管理します。

登録、可用性チェック、DNS、および管理を独自のシステムにワイヤリングします: 一括注文、更新スイープ、顧客向けのコントロール パネル。

API は、クライアント領域が提供するのと同じ操作へのマシン エントリ ポイントです。ページ上でできることはスクリプトでも可能です。

残り HTTPS と JSON 応答
API キー クライアント領域での作成と取り消し
完全なカバー範囲 クライアント領域と同様の操作
監査可能 通話はアカウントに記録されます

それは何ですか

  • エンドポイントはリソース (可用性、ドメイン、ネームサーバー、連絡先、注文、請求書) ごとにグループ化され、JSON を返します。
  • 認証には、クライアント領域で生成された API キーが使用されます。このキーはいつでも取り消したり置き換えたりできます。
  • 一般的な用途: 一括登録、有効期限のスイープ、独自のシステムへのドメイン状態の同期、クライアント用のセルフサービス パネル、自動化された証明書ワークフロー。
  • Web と同じビジネス ルールが適用されます。ドメインは何もないところから登録することはできず、移管にはドメインのロックが解除されていて、60 日が必要です。

仕組み

01

キーを作成する

クライアント領域で、実行する必要がある内容に範囲を絞った API キーを生成します。

02

ドキュメントを読む

エンドポイント、パラメータ、および応答形状。

03

小規模なテスト

自動化する前に、読み取り専用エンドポイントまたはいくつかのドメインを試してください。

04

ロギングを使用してライブに移行する

本番環境に移行する前に、再試行とログ記録を追加します。

在庫状況と検索

監視と選択のために一度に多くの名前を確認します。

登録と更新

注文、更新、注文ステータスの読み取り。

DNS とネームサーバー

レコードとネームサーバーの変更を一括でプッシュします。

連絡先管理

登録者、管理者、技術、請求を読み取り、更新します。

注文と請求書

注文、請求書、支払いステータスを読み取ります。

キーのローテーション

キーを取り消して交換します。各システムを独自のキーに保持します。

API の内容

リソース別

リソースできること
ドメイン空き状況の確認、登録、更新、ステータスと有効期限の読み取り
DNSネームサーバーの読み取りと設定、DNS レコードの管理
プライバシーと連絡先プライバシー レベルを設定し、4 つの連絡先の役割をすべて更新します
注文と請求注文、請求書、支払いステータスを読む
アカウント残高と基本的なアカウントの詳細を読む

接続する前に準備するもの

デバッグの大部分を節約する 4 つの小さなこと

  • 残高または有効な支払い方法: 登録と更新は実際の注文であり、資金がないと注文ステップで呼び出しは失敗します。
  • 再試行とエラー処理: ネットワーク ブリップ、レート制限、アップストリーム遅延が発生します。べき等読み取りを再試行します。注文の場合は、固有の参照先を送信し、再度書き込む前に確認してください。
  • ログ: 参照、ドメイン、応答コードを記録します。後で何かが争われた場合、それらのログがその行為が起こったことを証明する唯一の証拠となります。
  • 最小権限: 読み取り専用ジョブには書き込み可能なキーを使用せず、各システムに独自のキーを与えて、一方のキーを他のキーを壊すことなく取り消すことができるようにします。

API キーはアカウントのパスワードに相当します。これをサーバー側の環境変数またはシークレット マネージャーに保持し、フロントエンド コードやリポジトリには決して保持しないでください。

人々がそれをどのように使用するか

よくあるパターン

  • 一括登録事業者: 登録用に選択内容を送信し、結果を独自のバックエンドに書き込みます。
  • 更新スイープ: 有効期限が近づいているドメインを毎晩プルし、独自のリマインダーまたは更新タスクを発行します。
  • ホワイトラベル パネル: 顧客はここにサインインしなくても、製品内のドメインを管理できます。
  • 調整: スケジュールに従ってドメインと注文データを取得し、独自の台帳と照合します。

すべての注文に含まれるもの

API キー管理

目的ごとにキーを作成、取り消し、分離します。

ドキュメント

エンドポイント、パラメータ、および応答。

ドメインと DNS エンドポイント

DNS およびネームサーバーを検索、登録、更新します。

注文と請求のエンドポイント

注文、請求書、支払いステータス。

通話履歴

トラブルシューティングのためにアカウントに対して記録されます。

サポート

統合が正しく動作しない場合は、チケットを開きます。

よくある質問

APIには追加料金がかかりますか?

API 自体は別途料金はかかりません。あなたはそれが実行する事業運営の対価を支払います。偶発的または悪用を防ぐために、賢明なレート制限があります。

SDKはありますか?

API は標準の HTTPS および JSON であるため、どの HTTP クライアントでも動作します。ドキュメントには、直接適用できるリクエストの例が含まれています。

鍵が漏れたらどうなるの?

クライアント領域でそれを取り消して、新しいものを生成します。取り消しはすぐに有効になり、古いキーを使用したリクエストは拒否されます。

検査には費用がかかりますか?

読み取り専用の呼び出しには費用はかかりません。登録と更新は実際の注文であり、費用がかかるため、最初に少数のドメインでロジックを検証します。

API は、他の場所に登録されたドメインを管理できますか?

いいえ。クライアント領域とまったく同じように、このアカウントのドメイン上で動作します。

ご了承ください

  • API キーをサーバー上に保持します。ブラウザー コードまたはモバイル バンドルに同梱されているキーは公開キーです。
  • エンドポイントを注文する場合は、ネットワークの再試行が 2 回登録されたり請求されたりしないように、一意のリクエスト参照を送信し、書き込む前にチェックしてください。

始める準備はできていますか?

このサービスのページを開いて、いくつかの手順で完了します。先に質問したい場合は、チケットが人に届きます。