DOC《西部数码》

西部数码 域名、虚拟主机、企业邮局 API接口说明文档 版本号:1.

3 作者: 西部数码 发行日期:2008/03/31 更新日期:2011-6-3 版本变更说明 修改日期 版本号 修改说明 2008-3-31 1.0 域名、虚拟主机、企业邮局购买管理等基本功能 2011-6-3 1.0 修正域名解析的部分BUG,增加域名一键登录控制面板的示例代码. 2011-8-11 增加高级接口的说明. 2012-3-27 增加获取机房说明 说明:本接口开发时间较早,有些功能没有全部实现. http://www.west263.com/CustomerCenter/doc/west263api-new.doc 该接口为西部数码最新的api接口,功能更加强大. 前言 本文档描述了西部数码域名注册,虚拟主机,企业邮局API接口协议.本文档描述了基本的数据交换标准,其中包括数据格式,数据定义,以及一些相关约定. 目录 版本变更说明

2 1.API接口地址

7 2.参数说明

7 2.1公共参数

7 2.2行为参数(action)

8 2.2.1域名类

8 2.2.1.1域名注册

8 2.2.1.2修改联系人

11 2.2.1.3域名续费

12 2.2.1.5修改解析服务器(域名DNS修改)

13 2.2.1.6修改域名密码

13 2.2.1.9域名解析

14 2.2.1.9.1 显示域名当前解析记录

14 2.2.1.9.2 增加域名解析记录

14 2.2.1.9.3 删除域名解析记录

16 2.2.1.9.4 修改域名解析记录

16 2.2.1.10 显示域名信息

17 2.2.2 虚拟主机类

19 2.2.2.1 虚拟主机购买

19 2.2.2.2 虚拟主机续费

20 2.2.2.4.3修改主机管理密码(FTP密码)

23 2.2.3邮箱类

25 2.2.3.1 企业邮局购买

25 2.2.3.2 企业邮局续费

26 2.2.4其它类 2.2.4.1 获取机房列表…26 3.应答代码

31 3.1. 成功返回

32 3.2. 处理中返回,等待成功

32 3.3. 失败返回,不可能成功

32 4.应用示例

32 4.1 CN英文域名注册

33 4.2国际英文域名注册

33 4.3国际中文域名注册

34 4.4国内中文域名注册

36 4.5国际英文域名续费

37 5.错误代码

39 6.附件一:域名后缀

40 6.1 CN英文域名(国内英文域名)

40 6.2 国内中文域名(CNNIC中文通用域名)

41 6.3 国际英文域名

42 6.4 国际中文域名

42 6.5 Name域名

42 6.6 Mobi域名

42 6.7 Biz域名

42 6.8 Info域名

42 6.9 cc域名

42 6.10 tv域名

42 7.附件二:国家列表

42 8.附件三:单位行业

48 1.API接口地址 接口采用HTTP,GET,POST协议: 正式URL:http://api.west263.com/api/west263.asp 服务器端口:80 我司的DNS: 英文域名DNS1* ns1.myhostadmin.net IP 220.166.64.222 英文域名DNS2* ns2.myhostadmin.net IP 61.236.150.177 中文域名DNS1* ns1.myhostadmin.net IP 220.166.64.222 中文域名DNS2* ns2.myhostadmin.net IP 61.236.150.177 接口调试时可以申请试用虚拟主机、.CN类域名、.com/.net类国际域名,这类域名注册后可以删除并退款. 而.info/.tv等特殊域名请勿测试,一旦注册将不能退款. 西部数码api接口技术支持专员:028-62778877-219 提示:一般不提供技术支持,主要适用于成熟的系统如华众、星外等. 业务量小的请使用我司的代理平台. Api接口应用于华众系统的说明 :http://agentsys.cn/help/list.asp?unid=376 Api接口应用于星外系统的说明 : http://www.west263.com/faq/list.asp?unid=525 2.参数说明 2.1公共参数 注:所有各参数字符集为gb2312 以下参数是在访问接口时必须提供的,否则服务器直接返回错误信息. 序号 名称 说明 类型(长度) 备注

1 Userid 西数会员用户名 常量 西部数码会员用户名

2 Userstr md5( 会员用户名 Api连接密码 email vtime ) 常量(32位字符) md5,API认证函数 数字ID(西数会员用户名) api连接用户密码 邮箱(会员下邮箱) vtime为12位字符 例如当前时间是: 2006年8月30日8点15分vtime=200608300815 四项值依顺序连接,通过md5函数处理后,userstr值为32位的字符串.

3 Category domain 常量 产品类别为域名 host 产品类别为主机 mail 产品类别为邮箱 all 业务操作类,不具体产品类别

4 Action 操作行为 常量 根据不同功能,提供不同的数值,下面有详细说明.

5 Vtime vtime为12位字符 例如当前时间是: 2006年8月30日8点15分vtime=200608300815 注:服务器时间与成都时间相同

6 Sourceid 业务请求序号 字符(16位) 业务请求序号,用于标识每次业务请求的序号,此值必须唯一. 2.2行为参数(action) 根据不同功能,选择不同的行为数值,每次调用只能选择一种行为. 2.2.1域名类 2.2.1.1域名注册 action=activate 详细参数列表: 注:所有参数名称中英文字母都是小写 (此操作是收费的) 参数名 说明 类型(长度) 备注 domain 标准域名. 字符串(3-60) 例:west263.com domainpwd 域名口令 字符串(3-16) 数字及英文字母 Vyear 注册年数 数字 dns1 第一个解析服务器 服务器地址 默认为西部数码: Ns1.myhostadmin.net dns2 第二个解析服务器 服务器地址 默认为西部数码: Ns2.myhostadmin.net productid cn com cnch comch name mobi biz info cc tv ccch tvch bizch 常量 CN英文域名(国内英文域名) 国际英文域名 国内中文域名 国际中文域名 name域名 .mobi域名 .biz域名 .info域名 .cc域名 .tv域名 中文.cc域名 中文.tv域名 中文.biz域名 注:域名后缀请见附件1 注册人信息开始 address_en 英文地址 字符串(1-255) 英文类域名需要,包括: 国际英文域名 国际中文域名 .name域名 .mobi域名 .biz域名 .info域名 .cc域名 .tv域名 非此八类域名,即中文域名不需要 firstname 英文名 字符串(1-50) lastname 英文姓 字符串(1-50) organization_en 英文单位名称(域名所有人) 字符串(1-255) city 英文城市 字符串(1-255) state 英文省份 字符串(1-255) address_zh 地址(中文) 字符串(1-255) 中文类域名需要,包括: CN英文域名 国内中文域名 非此两类域名,即英文类域名时此5个参数为可选参数. name 联系人姓名(中文) 字符串(1-16) organization_zh 单位名称(中文) (域名所有人) 字符串(1-255) ccity 城市(中文) 字符串(1-255) cstate 省份(中文) 字符串(1-255) manager 单位法人(注册人需要) 字符串(1-16) 中文类域名需要,包括: CN英文域名 国内中文域名 organization_type 单位所属行业(只有注册人需要) 详细代码见附3 注:必须按附3格式传值 字符串(1-16) postcode 邮政编码 数字(6) country 国家代码 字符串(2) 中国为CN,更多请见附2 phone 国家代码-区号电话号-分机 数字以-分隔(30) 86-02862778877-1000 分机可选 注:必须按此格式传值 4位-12位-6位fax 国家代码-区号传真号-分机 数字以-分隔(30) email 邮件地址 字符串 标准邮件地址 注册人信息结束 以下三种联系人,重复注册人各参数名称即可 管理人: 注册人各参数前加 a_ 缴费人: 注册人各参数前加 b_ 技术人: 注册人各参数前加 t_ 也可以使用下面的共享模式. admin_same_as 管理人共享模式(可选) 1或者2 1:与西数相同 2:与注册人相同 tech_same_as 技术人共享模式(可选) 1或者2或者3 1:与西数相同 2:与注册人相同 3:与管理人相同 bill_same_as 缴费人共享模式(可选) 1或者2或者3或者4 1:与西数相同 2:与注册人相同 3:与管理人相同 4:与技术人相同 文字说明: a.其中联系人包括以下四种, 注册人、管理人、缴费人、技术人 注册人的信息是必须的,其他联系人,可以和前面相同,也可以单独提供.例如单独提供管理人信息,在注册人相应参数前面加 a_ . 如: a_ address_zh=四川省成都市万和路天象大厦4楼5号a_name=韦小宝 …等. 如果和注册人相同,设置admin_same_as参数的值为2. 如: admin_same_as=2 b如果admin_same_as,tech_same_as,bill_same_as赋值,则无需提供各自对应的联系人信息的每个参数的值. 2.2.1.2修改联系人 action= chgcontact (此操作是免费的) 详细参数列表: 参数名 说明 类型(长度) 备注 domain 标准域名 字符串(3-60) changetype 0:注册人 注:每次只能修改一种联系人 1:管理联系人 2:缴费联系人 3:技术联系人 4:过户 organization 单位名称 字符串(1-255) 即为:域名所有人 address 地址 字符串(1-255) city 所在城市 字符串(1-255) state 所在省份 字符串(1-255) postcode 邮政编码 数字 country 所在国家缩写 字符串(2) 中国为CN,更多请见附2 phone 国家代码-区号电话号-分机 数字以-分隔(30) 86-01064036880-1000 分机可选 fax 国家代码-区号传真号-分机 数字以-分隔(30) 86-01064036880-1000 分机可选 email 邮件地址 标准邮件地址 firstname 联系人名 英文字母(1-50) 英文类域名需要,包括: 国际英文域名 国际中文域名 .name域名 .mobi域名 .biz域名 .info域名 .cc域名 .tv域名 非此八类域名不需要 lastname 联系人姓 英文字母(1-50) name 联系人姓名 字符串(1-16) 中文类域名需要,包括: CN英文域名 国内中文域名 非此两类域名不需要 manager 单位法人(修改注册人/过户需要) 字符串(3-16) organization_type 所属行业(修改注册人/过户需要) 字符串(1-16) 注: 中文类域名上述信息为中文内容,包括: CN英文域名(国内英文域名) 国内中文域名 英文类域名上述信息为英文内容,包括: 国际英文域名 国际中文域名 Name域名 .mobi域名 .biz域名 2.2.1.3域名续费 action= renew (此操作是收费的) 详细参数列表: 参数名 说明 类型(长度) 备注 domain 域名 字符串100 标准域名,例如:west263.com,west263.name deaddate 续费后到期日 (请特别注意) 日期类型 例如: 当前域名到期日为2007-10-10,如要续费一年, 则deaddate=2008-10-10 vyear 续费年数 数字 1―10之间 2.2.1.5修改解析服务器(域名DNS修改) action=chgdns (此操作是免费的) 详细参数列表: 参数名 说明 类型(长度) 备注 domain 域名 标准域名 dnshost01 解析服务器1 主机域名 例: ns1.myhostadmin.net dnshost02 解析服务器2 主机域名 例: ns2.myhostadmin.net 2.2.1.6修改域名密码 action=chgpwd (此操作是免费的) 详细参数列表: 参数名 说明 类型(长度) 备注 domain 域名 标准域名 如:west263.com domainpwd 域名密码 字符串(3-16) 2.2.1.9域名解析 域名解析包括:显示域名的当前解析记录,显示解析记录,修改,删除. 可供增删改操作的记录类型有:A记录、MX记录、CNAME记录、 URL转发记录 2.2.1.9.1 显示域名当前解析记录 action= query_rr (此操作是免费的) 参数名 说明 类型(长度) 备注 domain 域名 标准域名 2.2.1.9.2 增加域名解析记录 action= add_rr (此操作20条内是免费的) 参数名 说明 类型(宽度) 备注 domain 域名 标准域名 rr 资源记录值 字符(20) 例如:ftp,www,mx等,可以为空,泛域名解析该此为 * type 记录类型,可为: a mx cname url 常量 记录类型,分别为: A记录 MX记录 CNAME记录 URL转发记录 value 记录值 字符 例:61.139.126.188 http://www.west263.com/index.htm等pri 例如:5 数字(2) 只有type=mx或type=url时此参数才有值 type=mx时意为优先级,为数字,值越小优先级越高. type=url时意为转发形式,为0至1级,

0 隐含转发,1为不隐含转发 显示域名解析记录返回代码说明:

200 表示命令请求正确

20060904 表示请求日期 A

4583 www.west263api.cn 61.139.126.2 MX

8566 @.west263api.cn mail 注:上面返回xml节点当中 <

record >

…… rec........