使用者介面(API)

用程式管理域名,而不是逐條點頁面。

把域名註冊、查詢、解析和管理接進你自己的系統:批量下單、自動化續費巡檢、給客戶的自助控制檯,都可以走接口完成。

接口提供的是管理能力的機器入口,與客戶中心裡能做的事一一對應;你在頁面上能做的操作,基本都能用接口完成。

REST 基於 HTTPS 的 JSON 接口
API Key 密鑰在客戶中心生成與管理
一一對應 與客戶中心功能對應的操作
可審計 接口調用寫入賬戶日誌

這是什麼

  • 接口按資源組織:域名查詢、域名管理、名稱伺服器、聯繫人、訂單與發票各有對應端點,返回 JSON。
  • 認證使用你在客戶中心生成的 API 密鑰,密鑰隨時可以作廢並重新生成。
  • 適合的場景:批量註冊與續費巡檢、把域名狀態同步到自己的系統、為客戶提供自助面板、自動化證書籤發流程。
  • 接口調用同樣受業務規則約束——域名不能憑空註冊,轉移仍需滿足解鎖與 60 天等條件。

如何運作

01

生成密鑰

在客戶中心的接口設置裡創建 API 密鑰,並限定用途。

02

讀文檔

查看接口說明,確認端點、參數與返回結構。

03

沙盒驗證

先用少量域名或只讀端點驗證調用與錯誤處理。

04

投入生產

加上重試與日誌,再接入正式流程。

域名查詢與可用性

批量查詢註冊狀態,適合選詞與監控。

註冊與續費

下單、續費、查詢訂單狀態。

DNS 與名稱伺服器

批量下發解析記錄與 NS 配置。

聯繫人管理

讀取與更新註冊人、管理、技術、賬單聯繫人。

訂單與發票

拉取訂單、發票與付款狀態。

密鑰可輪換

密鑰可隨時作廢重建,權限按需最小化。

接口能做什麼

按資源劃分的能力範圍

資源可以做什麼
域名查詢可用性、註冊、續費、查看狀態與到期日
解析讀取與設置名稱伺服器、維護 DNS 記錄
隱私與聯繫人設置隱私級別、更新四類聯繫人資料
訂單與賬單查詢訂單、發票與付款狀態
賬戶查詢餘額與基本資訊

接入前要準備什麼

四件小事,省掉後面大半的排錯時間

  • 賬戶餘額或可用的支付方式:註冊與續費走的是真實下單流程,餘額不足會在下單這一步失敗。
  • 錯誤處理與重試:網絡抖動、限流與上游延遲都可能發生,請對冪等接口做重試,對下單類接口用唯一請求號避免重複註冊。
  • 日誌:把請求號、域名、響應碼記錄下來。出現爭議時,這些日誌是唯一能證明動作發生過的東西。
  • 權限最小化:只讀場景不要用可寫密鑰;不同系統用不同密鑰,便於單獨作廢。

API 密鑰等同於賬戶密碼。請把它放在服務端的環境變量或密鑰管理服務裡,不要寫進前端代碼、不要提交到代碼倉庫。

常見的使用方式

別人是怎麼用它的

  • 批量註冊系統:把選詞結果批量提交註冊,並把結果回寫到自己後臺。
  • 續費巡檢:每天拉取即將到期的域名,按自定義規則生成續費或提醒任務。
  • 客戶自助面板:白標場景下,讓客戶在你的系統裡管理域名,而不用登錄我們的客戶中心。
  • 合規與對賬:定期導出域名與訂單資料,與內部臺賬覈對。

每筆訂單包含什麼

API 密鑰管理

自助生成、作廢與按用途區分密鑰。

接口說明文檔

端點、參數與返回結構說明。

域名與解析接口

查詢、註冊、續費、DNS 與 NS。

訂單與賬單接口

訂單、發票與付款狀態。

調用記錄

接口調用寫入賬戶日誌便於排查。

技術支持

接入中遇到問題可提交工單。

常見問題

接口要額外付費嗎?

接口本身不單獨收費,按下單產生的實際業務計費。調用頻率有合理上限,用於防止誤用與濫用。

有現成的 SDK 嗎?

接口是標準的 HTTPS + JSON,用任何語言的 HTTP 客戶端都能調用。文檔裡給出了請求示例,可以直接改寫。

密鑰泄露了怎麼辦?

立即在客戶中心作廢該密鑰並生成新的。作廢即時生效,使用舊密鑰的請求會立即被拒絕。

測試時會不會產生費用?

查詢類接口不產生費用;註冊與續費是真實下單,會產生費用。建議先在少量域名上驗證邏輯。

接口能管理不在 Ry.hk 註冊的域名嗎?

不能。接口只能操作 Ry.hk 賬戶下的域名,這與客戶中心一致。

請注意

  • API 密鑰請保存在服務端,不要放進瀏覽器端代碼或移動端包內。密鑰一旦公開就等同賬戶失守。
  • 下單類接口請使用唯一請求號並在寫入前判重,避免網絡重試導致重複註冊、重複付費。

準備好了嗎?

打開對應頁面,幾步就能完成;需要人幫忙時,工單與郵箱都在。