阳光互联域名和主机API接口.doc

第 1 页 共 17 页 上海有孚上海有孚上海有孚上海有孚 域名域名域名域名 APIAPIAPIAPI 接口说明文档接口说明文档接口说明文档接口说明文档 作 者: sundns 发行日期：2010/05/10 IDC 商城友情提供 注册网址 Document No.: 001 第 2 页 共 17 页 VER: 1.0 前言 本文档描述了上海有孚域名注册 API 接口协议。本文档描述了基本的数据交换标准，其 中包括数据格式，数据定义，以及一些相关约定。 目录 1API 接口地址接口地址3 2参数说明参数说明3 21 公共参数3 22 行为参数（ACTION）4 2.2.1 域名类4 域名注册.4 修改联系人.7 域名续费.8 注册主机(创建域名服务器) 9 修改解析服务器(域名 DNS 修改) 9 修改域名密码.9 修改主机 IP(修改域名服务器 IP) .10 域名转入.10 域名解析.10 .1 显示域名当前解析记录.10 .2 增加域名解析记录.11 .3 删除域名解析记录.12 .4 修改域名解析记录.13 .5 购买解析记录条数.13 0 显示域名信息13 1 参数限制15 1.1 Cn 域名以及国内中文域名 15 2.2.2 虚拟主机类.15 虚拟主机购买15 虚拟主机续费16 .3 修改主机管理密码(FTP 密码)17 IDC 商城友情提供 注册网址 Document No.: 001 第 3 页 共 17 页 VER: 1.0 1 1APIAPI 接口地址接口地址 接口采用HTTP，POST协议： 正式URL：/sundnsapi.aspx 管理域名的URL: /domainlogin.php 调用说明： 接口使用阳光互联分销商级别的数字ID（以下本文档简称为数字ID） ，即可调用。 测试URL：/sundnsapi.aspx 注意：使用测试URL时请使用如下参数： 数字ID，即userid：1 用户密码：111111 email： 2 2参数说明参数说明 2 21 1 公共参数公共参数 注：所有各参数字符集为 gb2312 以下参数是在访问接口时必须必须提供的，否则服务器直接返回错误信息。 序号序号名称名称说明说明类型类型(长度长度)备注备注 1 Userid 阳光互联数字 ID常量(6 位数字)阳光互联数字 ID 2 Userstrmd5( 数字 ID 用户密码 email vtime ) 常量(32 位字符) md5，API 认证函数 数字 ID(阳光互联数字 ID) 用户密码(ID 密码) 邮箱(ID 下邮箱) vtime 为 12 位字符 例如当前时间是： 2006 年 8 月 30 日 8 点 15 分 vtime=200608300815 四项值依顺序连接,通过 md5 函 数处理后，userstr 值为 32 位的 字符串。 IDC 商城友情提供 注册网址 Document No.: 001 第 4 页 共 17 页 VER: 1.0 domain 产品类别为域名 host 产品类别为主机 mail 产品类别为邮箱 3 Category all 常量 业务操作类，不具体产品类别 4 Action 操作行为常量根据不同功能，提供不同的数值， 下面有详细说明。 5 Vtimevtime 为 12 位字符 例如当前时间是： 2006 年 8 月 30 日 8 点 15 分 vtime=200608300815 注:服务器时间与北京时间相同 6 Sourceid 业务请求序号字符(16 位) 业务请求序号，用于标识每次业 务请求的序号，此值必须唯一。 2 22 2 行为参数（行为参数（actionaction） 根据不同功能，选择不同的行为数值，每次调用只能选择一种行为每次调用只能选择一种行为。 .1 域名类域名类 域名注册域名注册 action=activateaction=activate 详细参数列表： 注注：所有参数名称中英文字母都是小写所有参数名称中英文字母都是小写 另注另注: :国内域名请按下列红字提醒添加购买后提示国内域名请按下列红字提醒添加购买后提示! !“您的域名刚提交成功，只有通过域名注册 管理机构 CNNIC 的审核才表时您的域名正式注册成功。请您确保域名正式注册成功后再提交续费， 否则因为 CNNIC 审核不通过而删除域名，将不退还续费的费用。我们建议您在新域名成功 15 日 后再提交续费。给您带来不便之处，敬请谅解。” ( (此操作是收费的此操作是收费的) ) 参数名参数名说明说明类型类型(长度长度)备注备注 domain 标准域名。 字符串 （360） 例： domainpwd 域名口令字符串数字及英文字母 IDC 商城友情提供 注册网址 Document No.: 001 第 5 页 共 17 页 VER: 1.0 （316） vyear 注册年数数字 dns1 第一个解析服务器服务器地址 默认为阳光互联： dns2 第二个解析服务器服务器地址 默认为阳光互联： productid cn com cnch comch name mobi biz info cc tv ccch tvch bizch asia me tel 常量CN 英文域名(国内英文域名) 国际英文域名 国内中文域名 国际中文域名 name 域名 .mobi 域名 .biz 域名 .info 域名 .cc 域名 .tv 域名 中文.cc 域名 中文.tv 域名 中文.biz 域名 国际 asia 域名 注：域注：域名名后缀请后缀请见见附件附件 1 注册人信息开始 address_en 英文地址字符串（1255） firstname 英文名字符串（150） lastname 英文姓字符串（150） organization_en 英文单位名称(域名所有人)字符串（1255） city 英文城市字符串（1255） state 英文省份字符串（1255） 英文类域名需要，包括： 国际英文域名 国际中文域名 .name 域名 .mobi 域名 .biz 域名 .info 域名 .cc 域名 .tv 域名 非此八类域名，即中文域 名不需要 address_zh 地址(中文)字符串（1255） name 联系人姓名(中文)字符串（116） organization_zh 单位名称(中文) (域名所有人) 字符串（1255） ccity 城市(中文)字符串（1255） cstate 省份(中文)字符串（1255） 中文类域名需要，包括： CN 英文域名 国内中文域名 非此两类域名，即英文类 域名时此 5 个参数为可选 参数。 manager 单位法人（注册人需要）字符串（116）中文类域名需要，包括： CN 英文域名 IDC 商城友情提供 注册网址 Document No.: 001 第 6 页 共 17 页 VER: 1.0 organization_type 单位所属行业（只有注册人需 要） 详细代码见附 3 注：必须按附注：必须按附 3 3 格式传值格式传值字符串（116） 国内中文域名 postcode 邮政编码数字(6) country 国家代码字符串（2）中国为 CN,更多请见附 2 phone 国家代码-区号电话号-分机数字以-分隔(30) fax 国家代码-区号传真号-分机数字以-分隔(30) 86-01064036880-1000 分机可选 注：必须按此格式传值注：必须按此格式传值 4 4 位位-12-12 位位-6-6 位位 email 邮件地址字符串标准邮件地址 注册人信息结束 以下三种联系人，重复注册人各参数名称即可 管理人: 注册人各参数前加“a_“ 缴费人: 注册人各参数前加“b_“ 技术人: 注册人各参数前加“t_“ 也可以使用下面的共享模式。 注:asia 域名注册时,技术人信息必须且只能为阳光互联相同信息,信息录入选择技术人共享模式输入, tech_same_as=1 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=上海市浦东新区金茂大厦 3 层 a_name=韦小宝 等。 如果和注册人相同，设置 admin_same_as 参数的值为 2。 IDC 商城友情提供 注册网址 Document No.: 001 第 7 页 共 17 页 VER: 1.0 如： admin_same_as=2 b 如果 admin_same_as,tech_same_as,bill_same_as 赋值，则无需提供各自对应的联系人信 息的每个参数的值。 c.注册 asia 域名,技术人信息是必须的,而且只能为阳光互联信息,不能单独提供,使用与阳 光互联相同的技术人共享模式,设置参数 tech_same_as 的值为 1. 如: tech_same_as=1 修改联系人修改联系人 action=action= chgcontactchgcontact (此操作是免费的) 详细参数列表： 参数名参数名说明说明类型类型( (长度长度) )备注备注 domain 标准域名字符串（360） 0:注册人 1:管理联系人 2:缴费联系人 3:技术联系人 changetype 4:过户 注：每次只能修改一 种联系人 Asia 域名不能修改技 术联系人. organization 单位名称 字符串 （1255） 即为：域名所有人 address 地址 字符串 （1255） city 所在城市 字符串 （1255） state 所在省份 字符串 （1255） postcode 邮政编码数字 country 所在国家缩写字符串(2) 中国为 CN,更多请见 附 2 phone 国家代码-区号电话号-分机数字以-分隔(30) 86-01064036880-1000 分机可选 fax 国家代码-区号传真号-分机数字以-分隔(30) 86-01064036880-1000 分机可选 email 邮件地址标准邮件地址 IDC 商城友情提供 注册网址 Document No.: 001 第 8 页 共 17 页 VER: 1.0 firstname 联系人名 英文字母 （150） lastname 联系人姓英文字母 （150） organization_zh 单位名称(中文) 字符串 （1255） state_zh 省份(中文) 字符串 （1255） city_zh 城市(中文) 字符串 （1255） address_zh 地址(中文) 字符串 （1255） 英文类域名需要，包 括： 国际英文域名 国际中文域名 .name 域名 .mobi 域名 .biz 域名 .info 域名 .cc 域名 .tv 域名 非此八类域名不需要 name 联系人姓名字符串（116） manager 单位法人（修改注册人/过 户需要）字符串（316） organization_type 所属行业（修改注册人/过 户需要）字符串（116） 中文类域名需要，包 括： CN 英文域名 国内中文域名 非此两类域名不需要 注：注： 中文类域名上述信息为中文内容，包括：中文类域名上述信息为中文内容，包括： CN 英文域名(国内英文域名) 国内中文域名 英文类域名上述信息为英文内容，包括：英文类域名上述信息为英文内容，包括： 国际英文域名 国际中文域名 Name 域名 .mobi 域名 .biz 域名 域名续费域名续费 action=action= renewrenew ( (此操作是收费的此操作是收费的) ) 详细参数列表： 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名 标准域名，例如： ,, 也可以为通用网址，例： 阳光互联 IDC 商城友情提供 注册网址 Document No.: 001 第 9 页 共 17 页 VER: 1.0 deaddate 续费后到期日续费后到期日 ( (请特别注意请特别注意) ) 日期类型例如： 当前域名到期日为 2007- 10-10，如要续费一年， 则 deaddate=2008-10-10 vyear 续费年数数字 注册主机注册主机(创建域名服务器创建域名服务器) action=action= regdnsregdns ( (此操作是收费的此操作是收费的) ) 详细参数列表： 参数名参数名说明说明类型类型(长度长度)备注备注 0 数字（1） 国内英文（解析国内英文域名） 1 数字（1）国外（解析国际域名） 2 数字（1）name 域名（解析 name 顶级域名） 3 数字（1）国内中文（解析国内中文域名） regtype4 数字（1） .org/.biz/.cc/.tv/.info/域名 （解析.org/.biz/.cc/.tv/.info/域名） dnshost01 主机名主机域名域名服务器名称 例: dnshost01_ip 主机对应 IP标准 IP 标准 IP 注：一个 IP 只能注册一个主机 修改解析服务器修改解析服务器(域名域名 DNS 修改修改) action=chgdnsaction=chgdns ( (此操作是免费的此操作是免费的) ) 详细参数列表： 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名标准域名 dnshost01 解析服务器 1主机域名例: dnshost02 解析服务器 2主机域名例: 修改域名密码修改域名密码 action=chgpwdaction=chgpwd IDC 商城友情提供 注册网址 Document No.: 001 第 10 页 共 17 页 VER: 1.0 ( (此操作是免费的此操作是免费的) ) 详细参数列表： 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名标准域名 domainpwd 域名密码 字符串 （316） 修改主机修改主机 IP(修改域名服务器修改域名服务器 IP) action=chgdnshostaction=chgdnshost ( (此操作是免费的此操作是免费的, , 一天只能提交一次一天只能提交一次) ) 详细参数列表： 参数名参数名说明说明类型类型(长度长度)备注备注 dnshost01 主机名主机域名域名服务器名称 例： dnshost01_ip 主机对应 IP标准 IP例：31 域名转入域名转入 action=transferaction=transfer ( (此操作是收费的此操作是收费的) ) 详细参数列表： 参数名参数名说明说明类型类型(长度长度)备注备注 productid cn com cnch comch biz 常量CN 英文域名(国内英文域名) 国际英文域名 国内中文域名 国际中文域名 .biz 域名 domain 域名标准域名 domainpwd 域名口令字符串（316） 域名解析域名解析 域名解析包括：显示域名的当前解析记录，新增解析记录，修改，删除。 只读的记录类型有：SOA 记录，id=0 的 NS 记录，此两类记录不能进行删改操作 可供增删改操作的记录类型有：A 记录、NS 记录、MX 记录、CNAME 记录、 URL 转发记 录 .1 显示域名当前解析记录显示域名当前解析记录 action=action= query_rr IDC 商城友情提供 注册网址 Document No.: 001 第 11 页 共 17 页 VER: 1.0 (此操作是免费的) 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名标准域名 .2 增加域名解析记录增加域名解析记录 action=action= add_rr ( (此操作此操作 1010 条内是免费的条内是免费的) ) (一个域名超过 10 条解析记录时，需要另外购买，购买请参见：.5 购买解 析记录条数) 参数名参数名说明说明类型类型(宽度宽度)备注备注 domain 域名标准域名 rr 资源记录值字符（20）例如：ftp,www,mx 等,可以为空,泛域 名解析该此为 * type 记录类型,可为： a ns mx cname url 常量记录类型，分别为： A 记录 NS 记录 MX 记录 CNAME 记录 URL 转发记录 value 记录值字符例：8 /index.htm 等 pri 例如：5数字（2）只有 type=mx 或 type=url 时此参数才 有值 type=mx 时意为优先级,为数字，值越 小优先级越高。 type=url 时意为转发形式，为 0 至 1 级， 0 隐含转发，1 为不隐含转发 显示域名解析记录返回代码说明：显示域名解析记录返回代码说明： 200 表示命令请求正确 20060904 表示请求日期 SOA 1157726 20060830.cn IDC 商城友情提供 注册网址 Document No.: 001 第 12 页 共 17 页 VER: 1.0 NS 0 20060830.cn 注：上面返回 xml 节点当中 record 为遍历的每条解析记录，各节点名称及值如下： type 值表示不同的记录类型： SOA 表示 SOA 记录 A 表示 A 记录 NS 表示 NS 记录 MX 表示 MX 记录,即邮件交换记录 CNAME 表示 CNAME 记录 URL 表示 URL 转发 id 值表示：记录 ID name 值表示：RR 值，并域名，例如：， 等 values 表示：对应资源地址，如 IP，域名等。 ttl 表示：DNS 服务器上缓存时间 prio 表示：优先级 如返回如下信息需要另外购买解析条数：如返回如下信息需要另外购买解析条数： 300 需要购买解析条数 .3 删除域名解析记录删除域名解析记录 action =del_rr ( (此操作是免费的此操作是免费的) ) IDC 商城友情提供 注册网址 Document No.: 001 第 13 页 共 17 页 VER: 1.0 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名标准域名 rr_id资源记录 ID数字（1- 10） 此值通过 query 返回的 XML 得到 例： 7276826 即 rr_id=7276826 .4 修改域名解析记录修改域名解析记录 action = modify_rrmodify_rr ( (此操作是免费的此操作是免费的) ) 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名标准域名 rr_id资源记录 ID 数字（1- 10）同上 type 记录类型常量同上 value 记录值字符同上 pri 级别值数字（1-2）同上 ttl按原值传送 .5 购买解析记录条数购买解析记录条数 action = activate_rr ( (此操作是收费的此操作是收费的) ) 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名标准域名 productid 11321常量11321 0 显示域名信息显示域名信息 action = getdomaininfogetdomaininfo (此操作是免费的此操作是免费的) 参数名参数名说明说明类型类型(长度长度)备注备注 domain 域名字符标准域名，例： 域名显示结果说明： 200 域名 IDC 商城友情提供 注册网址 Document No.: 001 第 14 页 共 17 页 VER: 1.0 2006-05-16 域名成功日 2011-05-16 域名到期日 q1w2e3r5域名口令 主域名解析服务器 辅域名解析服务器 Beijing china地址(英文) liang名(英文) xiao姓(英文) yovole单位名称(英文) beijing城市(英文) beijing省份(英文) 中国北京地址(中文) 梁晓姓名(中文) 阳光互联单位名称(中文) 北京城市(中文) 北京省份(中文) 梁晓单位法人（注册人显示） S1单位所属行业代码 100011邮政编码 CN国家代码 86-01064242299-0000电话 86-01064242299-0000传真 邮件地址 填写管理人共享模式 Beijing china地址(英文) liang名(英文) xiao姓(英文) yovole单位名称(英文) beijing城市(英文) beijing省份(英文) 中国北京地址(中文) 梁晓姓名(中文) 阳光互联单位名称(中文) 北京城市(中文) 北京省份(中文) 100011邮政编码 CN国家代码 86-01064242299-0000电话 86-01064242299-0000传真 邮件地址 填写技术人共享模式 IDC 商城友情提供 注册网址 Document No.: 001 第 15 页 共 17 页 VER: 1.0 Beijing china地址(英文) liang名(英文) xiao姓(英文) yovole单位名称(英文) beijing城市(英文) beijing省份(英文) 中国北京地址(中文) 梁晓姓名(中文) 阳光互联单位名称(中文) 北京城市(中文) 北京省份(中文) 100011邮政编码 CN国家代码 86-01064242299-0000电话 86-01064242299-0000传真 邮件地址 填写缴费人共享模式 Beijing china地址(英文) liang名(英文) xiao姓(英文) yovole单位名称(英文) beijing城市(英文) beijing省份(英文) 中国北京地址(中文) 梁晓姓名(中文) 阳光互联单位名称(中文) 北京城市(中文) 北京省份(中文) 100011邮政编码 CN国家代码 86-01064242299-0000电话 86-01064242299-0000传真 邮件地址 1 参数限制参数限制 1.1 Cn 域名以及国内中文域名域名以及国内中文域名 涉及行为涉及行为: 域名注册,修改联系人; 参数限制参数限制: 由于 CNNIC 对 CN 域名信息比较严格,除以上限制的信息以外,其他信息也建议尽量 填