API 接口規範文檔
更新內容:2008-11-24 增加域名 Whois 信息查詢
2008-11-24 正式啓用API接口
說明: API支持GET/POST方式,建議使用 POST 方式。
所有POST數據必須使用 UTF-8 編碼對數據進行 URLEncode
除獲取服務器時間外的其他接口,每次請求都需要進行身份驗證。
建議使用獲取服務器時間接口來獲得 vtime 值。
1、獲取服務器時間接口
URL地址:
http://www.domain-api.com/api-get-time.html
返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<time>20080723153933</time>
</interface>
返回信息說明:
time 值:14位時間值,用於身份驗證的14位時間戳
2、身份驗證方法
URL地址:
參見下列接口 URL 地址
參數:
username 用戶名
vtime 14位時間戳
checksum 驗證字串 = MD5(username + MD5(用戶密碼) + vtime)
2、域名查詢接口
GET/POST地址:
http://www.domain-api.com/api-product-domain-query.html
參數:
domain 域名,如: abc.com,123.com,domain.cc 多個域名使用逗號間隔
正常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 200 ]]></return_code>
<return_msg><![CDATA[ 驗證通過 ]]></return_msg>
<check>
<domain>abc.com</domain>
<status>200</status>
<msg>可以註冊</msg>
</check>
<check>
<domain>123.com</domain>
<status>201</status>
<msg>不可註冊</msg>
</check>
<check>
<domain>domain.cc</domain>
<status>433</status>
<msg>查詢失敗</msg>
</check>
<check>
<domain>domain.aaa</domain>
<status>500</status>
<msg>錯誤的域名</msg>
</check>
</interface>
異常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 433 ]]></return_code>
<return_msg><![CDATA[ 異常詳細信息 ]]></return_msg>
</interface>
返回參數說明:
return_code 返回狀態代碼,成功 = 200
return_msg 返回詳細提示信息
domain = 域名
status = 域名查詢狀態代碼
200 = 可以註冊
201 = 不可註冊
433 = 查詢失敗
500 = 錯誤的域名
msg = 詳細說明
2、域名註冊接口
GET/POST地址:
http://www.domain-api.com/api-product-domain-buy.html
參數:
domain 域名,如: abc.com
year 註冊年限(1-5)年
dns1 主要DNS服務器 ns.dnsfamily.com
dns2 備用DNS服務器 ns.cdnhost.cn
dom_cn 域名所有者(中文) 成都世紀東方網絡通信有限公司
fn_cn 姓(中文) 小
ln_cn 名(中文) 明
country_cn 國家代碼(中文) 中國
provinces_cn 省份(中文) 四川
city_cn 城市(中文) 成都
address_cn 地址(中文) 成都市XXX
dom_en 域名所有者(英文) Oriental Century
fn_en 姓(英文) Xiao
ln_en 名(英文) Ming
country_en 國家代碼(英文) CN
provinces_en 省份(英文) Sichuan
city_en 城市(英文) Chengdu
address_en 地址(英文) Chengdu City
postcode 郵政編碼 610041
tel 電話號碼 +86.02882001809
fax 傳真號碼 +86.02882001809
email 電子郵件 [email protected]
正常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 200 ]]></return_code>
<return_msg><![CDATA[ 註冊成功 ]]></return_msg>
</interface>
異常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 433 ]]></return_code>
<return_msg><![CDATA[ 異常詳細信息 ]]></return_msg>
</interface>
返回參數說明:
return_code 返回狀態代碼,成功 = 200
return_msg 返回詳細提示信息
3、域名續費接口
GET/POST地址:
http://www.domain-api.com/api-product-domain-renew.html
參數:
domain 域名,如: abc.com
year 續費年限(1-5)年
expiredate 域名當前過期日期,如:2008-01-01
正常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 200 ]]></return_code>
<return_msg><![CDATA[ 續費成功 ]]></return_msg>
</interface>
異常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 433 ]]></return_code>
<return_msg><![CDATA[ 異常詳細信息 ]]></return_msg>
</interface>
返回參數說明:
return_code 返回狀態代碼,成功 = 200
return_msg 返回詳細提示信息
4、獲取域名信息接口
GET/POST地址:
http://www.domain-api.com/api-product-domain-view.html
參數:
domain 域名,如: abc.com
正常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 200 ]]></return_code>
<return_msg><![CDATA[ 驗證通過 ]]></return_msg>
<domain><![CDATA[ abc.com ]]></domain>
<password><![CDATA[ 123456 ]]></password>
<regdate><![CDATA[ 2008-01-01 ]]></regdate>
<expiredate><![CDATA[ 2009-01-01 ]]></expiredate>
<dns1><![CDATA[ ns1.abc.com ]]></dns1>
<dns2><![CDATA[ ns2.abc.com ]]></dns2>
<dom_en><![CDATA[ XX Company ]]></dom_en>
<fn_en><![CDATA[ FirstName ]]></fn_en>
<ln_en><![CDATA[ LastName ]]></ln_en>
<country_en><![CDATA[ CN ]]></country_en>
<provinces_en><![CDATA[ Beijing ]]></provinces_en>
<city_en><![CDATA[ Beijing ]]></city_en>
<address_en><![CDATA[ Beijing City ]]></address_en>
<dom_cn><![CDATA[ 某某公司 ]]></dom_cn>
<fn_cn><![CDATA[ 小 ]]></fn_cn>
<ln_cn><![CDATA[ 李 ]]></ln_cn>
<country_cn><![CDATA[ 中國 ]]></country_cn>
<provinces_cn><![CDATA[ 北京 ]]></provinces_cn>
<city_cn><![CDATA[ 北京 ]]></city_cn>
<address_cn><![CDATA[ 北京 ]]></address_cn>
<postcode><![CDATA[ 100000 ]]></postcode>
<tel><![CDATA[ +86.01012345678 ]]></tel>
<fax><![CDATA[ +86.01012345678 ]]></fax>
<email><![CDATA[ [email protected] ]]></email>
</interface>
異常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 433 ]]></return_code>
<return_msg><![CDATA[ 異常詳細信息 ]]></return_msg>
</interface>
返回參數說明:
return_code 返回狀態代碼,成功 = 200
return_msg 返回詳細提示信息
domain 域名
password 域名密碼
regdate 註冊日期
expiredate 過期日期
dns1 主要DNS服務器
dns2 備用DNS服務器
dom_cn 域名所有者(中文) 成都世紀東方網絡通信有限公司
fn_cn 姓(中文) 小
ln_cn 名(中文) 明
country_cn 國家代碼(中文) 中國
provinces_cn 省份(中文) 四川
city_cn 城市(中文) 成都
address_cn 地址(中文) 成都市XXX
dom_en 域名所有者(英文) Oriental Century
fn_en 姓(英文) Xiao
ln_en 名(英文) Ming
country_en 國家代碼(英文) CN
provinces_en 省份(英文) Sichuan
city_en 城市(英文) Chengdu
address_en 地址(英文) Chengdu City
postcode 郵政編碼 610041
tel 電話號碼 +86.02882001809
fax 傳真號碼 +86.02882001809
email 電子郵件 [email protected]
5、域名修改DNS接口
GET/POST地址:
http://www.domain-api.com/api-product-domain-dns.html
參數:
domain 域名,如: abc.com
dns1 主要DNS服務器地址,如:ns.dnsfamily.com
dns2 備用DNS服務器地址,如:ns.cdnhost.cn
正常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 200 ]]></return_code>
<return_msg><![CDATA[ 修改成功 ]]></return_msg>
</interface>
異常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 433 ]]></return_code>
<return_msg><![CDATA[ 異常詳細信息 ]]></return_msg>
</interface>
返回參數說明:
return_code 返回狀態代碼,成功 = 200
return_msg 返回詳細提示信息
6、獲取域名 Whois 信息接口
GET/POST地址:
http://www.domain-api.com/api-product-domain-whois.html
參數:
domain 域名,如: abc.com
正常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 200 ]]></return_code>
<return_msg><![CDATA[ 驗證通過 ]]></return_msg>
<whois><![CDATA[ Whois 信息 ]]></whois>
</interface>
異常返回信息:
<?xml version="1.0" encoding="utf-8" ?>
<interface>
<return_code><![CDATA[ 433 ]]></return_code>
<return_msg><![CDATA[ 異常詳細信息 ]]></return_msg>
</interface>
返回參數說明:
return_code 返回狀態代碼,成功 = 200
return_msg 返回詳細提示信息
whois Whois 信息