whois 接口文档

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  电话号码  [phone]
  fax  传真号码  [phone]
  email  电子邮件  [e-mail]
 正常返回信息：
  <?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[ [e-mail] ]]></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  电话号码  [phone]
  fax  传真号码  [phone]
  email  电子邮件  [e-mail]

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 信息