入口及檢驗

目錄

1、URL

HTTP API 地址是 ://api.www.wsppn.com:2080

2、驗證

所有發送的請求都需要如下驗證參數:

auth-userid: 您當前的代理商賬號 ID(查詢您的代理 ID)

api-key: 一串用于認證 API 命令調用字母數字代碼(閱讀如下提示,查詢您的 API Key)

注: auth-userid和api-key全部用get請求方式,接口業務參數請參見接口HTTP方式要求。

3、找到您的代理商ID,API Key,和授權IP

1.登錄您的代理商控制面板

2.在左側功能欄最上方代理號碼:****寫的一般是六到七位數字就是代理ID

3.在左側功能欄找到“HTTP API接口管理”下面的“修改重置API KEY”,可以初使化生成API驗證密碼也就是API KEY,也可以在同一頁面修改API密碼

4.在左側功能欄找到“HTTP API接口管理”下面的"更改接口驗證IP”,可以授權您要調用 接口的服務器IP進行授權,沒有授權將無法使用接口

注意

重新生成一個新的 API Key 意味著您舊的 API Key 馬上失效,這將會對您的現有 API驗證失敗

4、API

HTTP API 要求所有用于檢索數據的請求應使用 GET 方法而提交,更改以及刪除數據的請求應使用 POST方法。如果您沒有使用正確的方法發送請求,那么特殊 HTTP 方法的請求則會返回錯誤值。然而,為了使您能夠更簡便地用瀏覽器及命令行工具測試 API,我們提供了測試 URL,讓您能夠使用 GET



域名查詢
目錄

1、描述

查詢某一特定域名是否可注冊

2、參數

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
domain-name 字符串數組 必填 需要查詢的域名
Tlds 字符串數組 必填 待查詢域名的頂級域后綴

3、HTTP 方式

GET方式

4、測試 URL 請求范例

/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net

5、接口返回值 Top

返回一個 hash Map,其中包含所查詢的頂級域名后綴的 availability status:

域名查詢狀態(status)

available -域名可以注冊

unavailable-域名已經被注冊

建立聯系人模版
目錄

1、描述

利用提供的詳細信息給域名添加聯系人

2、參數

名稱 數據類型 必填/可選 描述
auth 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
name 字符串 必填 聯系人名稱(英文) (字符限制 255)
name-loc 字符串 必填 聯系人名稱(中文) (字符限制 255)
company 字符串 必填 公司名稱(英文)(字符限制 255)
company-loc 字符串 必填 公司名稱(中文)
email 字符串 必填 聯系人 email 地址
address-line-1 字符串 必填 聯系人地址第一行(英文)(字符限制64)
address-loc-line-1 字符串 必填 聯系人地址第一行(中文)(字符限制64)
city 字符串 必填 城市名稱英文或拼音(字符限制 64)
country 字符串 必填 國家代碼參考 ISO 3166-1 alpha-2 (字符限制 2)
zipcode 字符串 必填 郵編 (字符限制 10)
mobile-cc 字符串 必填 電話國家代碼 (字符限制 3)
mobile 字符串 必填 電話國家代碼 (字符限制 3)
phone-cc 字符串 必填 電話國家代碼 (字符限制 3)
phone 字符串 必填 電話號碼 (字符限制 12)
address-line-2 字符串 可選 聯系人地址第二行 (字符限制 64)
address-line-3 字符串 可選 聯系人地址第三行 (字符限制 64)
state 字符串 必填 省份/州名稱 英文或拼音(字符限制 64)
fax-cc 字符串 必填 傳真國家代碼 (字符限制 3)
fax 字符串 必填 傳真號碼 (字符限制 64)
注:中文信息也可以寫英文,但英文不可以寫中文

3.HTTP 方法

POST

URL 請求范例

/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&name-lo[email protected]domain.com&address-line-1=address1&address-loc-line-1=address1-loc&city=city&country=nn&zipcode=0&phone-cc=0&phone=0

4.接口返回值

返回新添加的聯系人的 Contact Id (整數值) 。不同類型的聯系人可以使用相同的名稱和公司名稱

URL 請求范例

/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&name-lo[email protected]domain.com&address-line-1=address1&address-loc-line-1=address1-loc&city=city&country=nn&zipcode=0&phone-cc=0&phone=0

5.接口響應

如遇到錯誤,會返回包含 ERROR和錯誤信息的狀態值



Register 域名注冊
目錄

1.描述

注冊一個域名

2、參數

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
domain-name 字符串數組 必填 您需要注冊的域名
years 整數 必填 您要注冊的域名的年數
ns Array of Strings 必填 域名的 DNS域名服務器
reg-contact-id 整數 必填 域名的 注冊人聯系 ID
admin-contact-id 整數 必填 域名的 管理聯系人 ID

3.HTPP方式

POST

4.測試 URL 請求范例 Top

/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com ®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5.接口響應 Top

返回值如下:

域名注冊訂單 ID (entityid):

域名服務器修改操作描述 (actiontypedesc)

域名服務器修改狀態 (actionstatus)

域名服務器修改狀態描述(actionstatusdesc)

如出現任何錯誤,狀態會返回值為 Error 并附帶一條錯誤信息



獲取域名ID
目錄

1、描述

獲取已注冊域名的ID

2、參數

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
domain-name 字符串 必填 想要獲取 ID 的已注冊域名

3、HTTP 方式

GET

4、測試 URL 請求范例

/api/domains/orderid.json?auth-userid=0&api-key=key&domain-name=domain.com

4、接口響應

返回已注冊域名對應的ID(整數)



通過域名 ID 獲取域名注冊訂單信息
目錄

1、描述

通過特定的域名 ID 獲取相關的 域名注冊訂單信息

2、參數 Top

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 需要獲取信息的 域名注冊訂單的 ID
options 字符串數組 必填 值可設置為:All

3、HTTP 方式

GET

4、測試 URL 請求范例

/api/domains/details.json?auth-userid=0&api-key=key&order-id=0&options=All

5、接口響應

返回一個 hash map 包含域名注冊訂單的信息:

域名 ID (entityid)

域名 (domainname)

訂單描述 (description)

目前的訂單狀態(currentstatus) (暫時未啟用忽略)

域名狀態(orderstatus)

訂單生成日期(以注冊局時間為準)(creationtime)

過期日期(以注冊局時間為準) (endtime)

該訂單是否只屬于代理商賬戶下的某一客戶 (isImmediateReseller) (暫時未啟用忽略)

注冊聯系人 ID (registrantcontactid)

管理聯系人 ID(admincontactid)

技術聯系人 ID (techcontactid)

賬單聯系人 ID (billingcontactid)

域名服務器(ns1 and ns2)



域名續費
目錄

1、描述

對于特定的 域名訂單進行特定年數的續費操作

2、參數 Top

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 您想要續費的 域名訂單號
years 整數 必填 您想要對該域名續費的年數
exp-date 整數 必填 訂單現在的過期日,用 epoch time 格式

3、HTTP 方式

POST

4、測試 URL 請求范例

/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036

5、接口響應 Top

返回值如下:

域名注冊訂單 ID (entityid)

域名服務器修改操作描述 (actiontypedesc)

域名服務器修改狀態 (actionstatus)

域名服務器修改狀態描述(actionstatusdesc)

如出現任何錯誤,狀態會返回值為 Error 并附帶一條錯誤信息



修改域名 DNS 服務器
目錄

1、描述

修改指定 域名訂單的域名 dns 服務器

2、參數

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 需要獲取信息的 域名注冊訂單的 ID
ns 字符串數組 必填 新的域名 dns 服務器

3、HTTP 方式

POST

4、測試 URL 請求范例

/api/domains/modify-ns.json?auth-userid=0&api-key=key&order-id=0&ns=ns1.domain.asia&ns=ns2.domain.asia

5、接口響應

返回值如下:

域名注冊訂單 ID (entityid)

域名服務器修改操作描述 (actiontypedesc)

域名服務器修改狀態 (actionstatus)

域名服務器修改狀態描述(actionstatusdesc)

如出現任何錯誤,狀態會返回值為 Error 并附帶一條錯誤信息



域名過戶(修改聯系人)
目錄

1、描述

修改特定域名訂單的聯系人信息

2、參數 Top

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 需要獲取信息的 域名注冊訂單的 ID
reg-contact-id 整數 必填 新注冊聯系人 ID
admin-contact-id 整數 必填 新注冊聯系人 ID
tech-contact-id 整數 必填 新技術聯系人 ID
billing-contact-id 整數 必填 新賬單聯系人 ID

3、HTTP 方式

POST

4、測試 URL 請求范例

/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5、接口響應

返回值如下:

域名注冊訂單 ID (entityid)

域名服務器修改操作描述 (actiontypedesc)

域名服務器修改狀態 (actionstatus)

域名服務器修改狀態描述(actionstatusdesc)

如出現任何錯誤,狀態會返回值為 Error 并附帶一條錯誤信息



Transfer 轉入和提交密碼

一、Transfer 轉入


目錄

1、描述

轉移域名

注意 您必須確保域名已經解鎖。

2、參數 Top

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
auth-key 字符串 必填 認證參數 API KEY
domain-name 字符串 必填 指定你要轉移的域名
auth-code 字符串 必填 您要轉移的域名的授權碼(也叫 轉移密碼)
reg-contact-id 整數 必填
admin-contact-id 整數 必填
tech-contact-id 整數 必填
billing-contact-id 整數 必填

3、HTTP 方式

POST

4、測試 URL 請求范例

/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5、接口響應

返回值如下:

域名注冊訂單 ID (entityid)

域名服務器修改操作描述 (actiontypedesc)

域名服務器修改狀態 (actionstatus)

域名服務器修改狀態描述(actionstatusdesc)

如出現任何錯誤,狀態會返回值為 Error 并附帶一條錯誤信息



二、提交域名轉移密碼


目錄

1、描述

為正在轉入 ResellerClub 的域名提交域名轉移碼(也稱之為授權碼)

注意 您必須確保域名已經解鎖。

2、參數 Top

名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 轉入域名的訂單 ID
auth-code 字符串 必填 轉入域名的轉移碼或授權碼

3、HTTP 方式

GET

4、測試 URL 請求范例

/api/domains/transfer/submit-auth-code.xml?auth-userid=0&api-key=0&order-id=12345678&auth-code=authcodegoeshere

5、接口響應

如提供的授權碼為正確的,將返回值 success(字符串),域名轉入進程將會繼續。如出現任何錯誤信息,將會返回狀態值為 Error,和具體的錯誤信息



 
?