MyName 網域註冊服務

WebNIC API v2 文件

完整的 WebNIC API v2 技術文件，包含所有端點、參數和範例程式碼。

返回 API 文件首頁
網域註冊 API Bearer Token 認證 RESTful 設計 JSON 格式

目錄

基礎資訊

認證

網域操作

管理功能

參考資料

開發者資源

概述

WebNIC API v2 是一個完整的網域註冊和管理 API，提供以下功能：

  • 網域可用性查詢
  • 網域註冊與續約
  • 網域轉移（轉入/轉出）
  • 聯絡人（WHOIS）管理
  • 名稱伺服器（DNS）管理
  • 帳戶餘額查詢
  • 網域資訊查詢

注意： WebNIC API v2 使用 Bearer Token 認證，所有請求必須包含有效的存取權杖。

繼續閱讀

這只是 WebNIC API v2 文件的第一部分。了解更多關於網域轉移、續約、管理功能和錯誤處理的詳細資訊。

前往第二部分：網域轉移與管理 返回 API 文件首頁

第二部分包含：

網域轉移 網域續約 網域資訊 管理功能 錯誤代碼

網域轉移

將網域從其他註冊商轉移到 WebNIC。

POST /domain/v2/transfer
轉移網域

請求參數

參數 類型 說明 必填
domainName string 網域名稱（例如：example.com） 必填
authCode string 授權碼（從原註冊商取得） 必填
registrantContactId string 註冊人聯絡人 ID 必填
adminContactId string 管理聯絡人 ID 必填
techContactId string 技術聯絡人 ID 必填
billingContactId string 帳務聯絡人 ID 必填
nameservers array 名稱伺服器陣列 選填
whoisPrivacy boolean 是否啟用 WHOIS 隱私保護 選填

請求範例

JSON 
{
  "domainName": "example.com",
  "authCode": "ABC123DEF456",
  "registrantContactId": "C12345678",
  "adminContactId": "C12345678",
  "techContactId": "C12345678",
  "billingContactId": "C12345678",
  "nameservers": ["ns1.example.com", "ns2.example.com"],
  "whoisPrivacy": true
}

回應範例

JSON 
{
  "code": 0,
  "data": {
    "domainName": "example.com",
    "orderId": "TRF12345678",
    "status": "pending",
    "price": 12.00,
    "currency": "USD"
  }
}

注意： 網域轉移通常需要 5-7 天完成，期間網域服務不會中斷。

重要： 轉移網域前請確保網域已解鎖且授權碼正確，否則轉移會失敗。

API 網址

WebNIC API v2 提供兩個主要基礎網址：

正式環境

用於生產環境

網域相關 API:
https://api.webnic.cc/domain/v2

經銷商/帳戶相關 API:
https://api.webnic.cc/reseller/v2

測試環境

用於開發和測試

網域相關 API:
https://oteapi.webnic.cc/domain/v2

經銷商/帳戶相關 API:
https://oteapi.webnic.cc/reseller/v2

提示： 開發時請使用測試環境，避免影響正式環境的資料和產生費用。

請求標頭

所有 API 請求必須包含以下標頭：

HTTP Headers 
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access_Token>

注意： Authorization 標頭中的 <Access_Token> 必須替換為實際取得的存取權杖。

認證：取得 Token

在使用任何 API 功能前，必須先取得存取權杖（Access Token）。

POST /reseller/v2/api-user/token
使用 API Username 與 Secret 交換 Token

請求參數

參數 類型 說明 必填
username string API 使用者名稱 必填
password string API 密鑰（Secret） 必填

請求範例

JSON 
{
  "username": "your_username",
  "password": "your_api_secret"
}

回應範例

JSON 
{
  "code": 0,
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_in": 3600
  }
}

重要： Token 有效期為 3600 秒（1小時）。請在 Token 過期前重新取得或實作自動刷新機制。

提示： 建議快取 Token 以減少認證請求次數，但請注意 Token 的有效期限。

網域查詢

檢查網域是否可註冊。

GET /domain/v2/query
檢查網域可用性

請求參數

參數 類型 說明 必填
domainName string 網域名稱（例如：example.com） 必填
period integer 註冊年限（1-10年） 必填
registrantContactId string 註冊人聯絡人 ID 必填
adminContactId string 管理聯絡人 ID 必填
techContactId string 技術聯絡人 ID 必填
billingContactId string 帳務聯絡人 ID 必填
nameservers array 名稱伺服器陣列（最多 13 個） 選填
whoisPrivacy boolean 是否啟用 WHOIS 隱私保護 選填
autoRenew boolean 是否啟用自動續約 選填

請求範例

JSON 
{
  "domainName": "example.com",
  "period": 1,
  "registrantContactId": "C12345678",
  "adminContactId": "C12345678",
  "techContactId": "C12345678",
  "billingContactId": "C12345678",
  "nameservers": ["ns1.example.com", "ns2.example.com"],
  "whoisPrivacy": true,
  "autoRenew": true
}

回應範例

JSON 
{
  "code": 0,
  "data": {
    "domainName": "example.com",
    "orderId": "ORD12345678",
    "expiryDate": "2026-03-25T00:00:00Z",
    "price": 12.00,
    "currency": "USD"
  }
}

注意： 網域註冊成功後，可能需要 24-48 小時才能在全球 DNS 系統中生效。

重要： 註冊網域前請確保帳戶有足夠餘額，否則註冊會失敗。

string 網域名稱（例如：example.com） 必填

請求範例

HTTP 
GET https://api.webnic.cc/domain/v2/query?domainName=example.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
Accept: application/json

回應範例

JSON 
{
  "code": 0,
  "data": {
    "domainName": "example.com",
    "available": true,
    "price": 12.00,
    "currency": "USD"
  }
}

注意： 網域查詢結果僅供參考，實際註冊時可能因其他用戶同時註冊而失敗。

聯絡人管理

註冊網域前需建立 WHOIS 聯絡人資訊。聯絡人分為四種類型：

POST /domain/v2/contact
建立聯絡人

請求參數

參數 類型 說明 必填
name string 聯絡人姓名 必填
email string 電子郵件地址 必填
organization string 組織/公司名稱 選填
address1 string 地址第一行 必填
city string 城市 必填
state string 州/省 選填
country string 國家代碼（ISO 3166-1 alpha-2） 必填
zipCode string 郵遞區號 必填
phone string 電話號碼（格式：+886.912345678） 必填

請求範例

JSON 
{
  "name": "王小明",
  "email": "wang@example.com",
  "organization": "範例有限公司",
  "address1": "信義區信義路五段7號",
  "city": "台北",
  "state": "台北",
  "country": "TW",
  "zipCode": "110",
  "phone": "+886.912345678"
}

回應範例

JSON 
{
  "code": 0,
  "data": {
    "contactId": "C12345678"
  }
}

重要： 聯絡人資訊必須真實有效，虛假資訊可能導致網域被暫停或刪除。

網域註冊

註冊新的網域。

POST /domain/v2/register
註冊網域

請求參數

參數 類型 說明 必填
domainName string 網域名稱（例如：example.com） 必填
term integer 註冊年限（1-10年） 必填
registrantContactId string 註冊人聯絡人 ID 必填
adminContactId string 管理聯絡人 ID 必填
techContactId string 技術聯絡人 ID 必填
billingContactId string 帳務聯絡人 ID 必填
nameservers array 名稱伺服器陣列（最多 13 個） 選填
whoisPrivacy boolean 是否啟用 WHOIS 隱私保護 選填
autoRenew boolean 是否啟用自動續約 選填

請求範例

JSON 
{
  "domainName": "example.com",
  "term": 1,
  "registrantContactId": "C12345678",
  "adminContactId": "C12345678",
  "techContactId": "C12345678",
  "billingContactId": "C12345678",
  "nameservers": ["ns1.example.com", "ns2.example.com"],
  "whoisPrivacy": true,
  "autoRenew": true
}

回應範例

JSON 
{
  "code": 0,
  "data": {
    "domainName": "example.com",
    "orderId": "ORD12345678",
    "expiryDate": "2026-03-25T00:00:00Z",
    "price": 12.00,
    "currency": "USD"
  }
}

注意： 網域註冊成功後，可能需要 24-48 小時才能在全球 DNS 系統中生效。

重要： 註冊網域前請確保帳戶有足夠餘額，否則註冊會失敗。