PDF《API》

API 用户使用手册 2.

4 版本(2017 年09 月30 日) API 用户使用手册 目录1. 目的.4 2. 适用范围.4 3. 参考文档.4 4. 缩写.4 5. 名词定义.4 6. API 系统概述.5 6.1. 系统简介.5 6.2. 系统功能.5 6.3. 支持产品类型.5 6.4. demo 在线演示系统.6 6.5. 更新记录(changelog)6 6.6. 注意事项.6 7. API 系统.7 7.1. 服务器交互.7 7.1.1. 联接服务器地址.7 7.1.2. 建立 TCP 连接.7 7.1.3. 建立会话(session)及登录(Login)7 7.1.4. 向服务器提交请求.9 7.1.5. 获得命令返回结果.9 7.1.6. 结束会话断开连接(Logout)9 7.2. 域名业务.10 7.2.1. 联系人.10 7.2.2. 域名.25 7.2.3. DNS.49 7.2.4. 域名转移会员号.60 7.2.5. 域名转入注册商.67 7.3. 主机业务.73 7.3.1. 主机型号说明.73 7.3.2. 传统主机.73 7.3.3. 智强主机.74 7.4. 邮局业务.107 7.4.1. 邮局类型说明.107 7.4.2. 普通邮局.107 7.4.3. 包销邮局.147 7.5. 帐户管理.181 7.5.1. GetAccountBalance 查看代理帐户余额.181 7.5.2. GetCustomerInfo 查看代理详细信息.183 7.5.3. ModCustomerInfo 修改代理详细信息.186 7.6. 附加功能.188 7.6.1. 价格查询.188 8. 附录.207 API 用户使用手册 8.1. 国家代码表.207 8.1.1. EU 域名注册联系人支持的国家代码.207 8.1.2. 其他域名注册联系人支持的国家代码.208 8.2. 域名类型.208 8.2.1. COM/NET 域名多语种类型.208 8.2.2. CN 域名类型.210 8.2.3. IN 域名类型.210 8.2.4. BIZ 域名多语种类型.210 8.2.5. NAME 域名类型.211 8.3. ASIA 域名的 CED 信息.211 8.3.1. CED 法人实体类型.211 8.3.2. CED 证书类型.211 8.4. CN 域名所属企业的行业类别.211 8.5. 域名转入注册商状态.212 8.6. 错误代码.212 8.7. 报文格式.215 8.8. 域名格式.217 8.9. 智强主机服务器开设地点对应表.217 8.10. 主机升级参数说明表.218 8.11. 密码加密方法.218 8.12. 邮局服务器开设地点对应表.221 8.13. UK 域名的组织类型.222 API 用户使用手册 1. 目的 本文档主要描述了中国频道关于域名、主机、邮局等实时在线注册及管理等完整业务的 API 系 统接口协议,其中包括客户端与服务器端的交互模式,各API 接口的功能说明、命令格式、数据定 义、业务限制和相关约束条件,以及各 API 业务与系统交互的 demo 使用链接和命令实例. 在保证数据、编码、信息传输安全的基础上,各代理商能够自主灵活地在自已熟悉的操作系统 平台上,使用自已熟悉的编程语言和数据库,通过本文档中介绍的技术开发资料和接口标准,在新 开发的或已有的业务系统中,实现与中国频道实时在线注册接口的对接. 2. 适用范围 本文档的阅读对象为代理商和加盟店平台的软件开发工程师,及将要开发与中国频道实时注册 系统相似业务的代理商的软件开发工程师. 3. 参考文档 《Template 4.0 技术手册》. 4. 缩写 缩写 英文全称 中文全称 API Application Program Interface 应用程序接口 5. 名词定义 名词 定义API 应用程序接口,由公司自已制定一套系统接口标准,客户 可通过该接口标准与内部系统进行通信,实现数据共享. API 用户使用手册 6. API 系统概述 6.1. 系统简介 此API 接口是根据中国频道客户对我司实时注册系统使用的反馈情况,及域名、主机、邮局等 其它产品和服务的变化而设计的,是一个实现了中国频道较为全面的产品业务与实时注册系统的接 口. 针对商家提供的产品业务的应用程序编程接口,由我司规范报文格式,商家可根据这些报文格 式,基于 socket 网络连接将相应的报文数据传输到 API 接口程序,轻松实现域名、主机、邮局等产 品购买、产品管理、产品查询的功能.商家无需了解内部实现的工作细节,只需要构造对应产品及 对应功能的报文信息,即可根据自己的需要自主自由地进行业务开发,实现与实时注册系统的数据 共享. 中国频道经过长期的摸索和实践,采用了校验码的安全保密机制,以确保客户提交命令的正确 性得到极高程度的安全性保证. 6.2. 系统功能 目前 API 主要实现了较为完整的域名、主机、邮局等实时在线注册、续费、查询、更新、删除 等相关业务功能. 其中,域名业务的主要功能有:域名联系人管理、host 管理、域名注册、续费、删除、更改域 名DNS、修改域名密码、检查域名能否注册、域名过户、域名转移会员号、域名转入注册商、域名 信息保护、域名锁定/解锁服务、域名自动续费设置、查看域名详细信息等. 主机业务的主要功能有:传统主机的续费、流量升级、空间升级、升级至智强 G 型主机、修改 主机密码、获取主机流量、获取主机信息;

智强主机的检查主机是否可开设、主机创建、主机续费、 开设主机赠送的数据库、检查主机赠送邮局是否可开设、开设邮局、流量升级、空间升级、型号升 级、升级至智强 G 型主机、升级主机赠送数据库空间、购买定时备份、修改密码、获取主机流量;

以及查询主机各种操作的价格等. 邮局业务的主要功能有:普通邮局的检查是否可开设、创建、续费、升级企业邮箱 M 邮空间、 升级环球即时邮用户数、升级全球转发、升级邮件监控、升级公文包、获取当前剩余短信条数、购 买短信条数、修改密码、开通/关闭、获取信息;

包销邮局的检查是否可开设、创建、续费、升级企 业邮箱 M 邮空间、升级环球即时邮用户数、升级全球转发、升级邮件监控、升级公文包、获取当前 剩余短信条数、购买短信条数、修改密码、开通/关闭、获取信息、购买包销点数、查询包销账户信 息、删除邮局以及查询邮局各种操作的价格或者包销点数等. 6.3. 支持产品类型 API 用户使用手册 业务类型 产品类型 产品型号 域名业务 域名 com、 net、 org、 中国/网络/公司、 cn、 biz、 info、 us、in、mobi、eu、asia、me、name、cc、tv、 uk、tw、tel 主机业务 传统主机 试用机、普及型、简约型、商务型、高级型、海 外型、商务型(asp.net)、JSP 型(试用)、入门

1 型 智强主机 智强

100 、智强云

300、智强

200、智强

300、智强

350、智强

600、智强

950、智强

1650、智强 豪华型、双线智强

150、入门

2 型、入门

3 型、 入门

4 型、全能

150、中频-商用

500、中频-云防500 海外智强

100、海外智强

200、海外智强

350 智强神州通Ⅰ型、智强神州通Ⅱ型、智强神州通 Ⅲ型、智强神州通Ⅳ、智强神州通 G+ 智强 G 型、(G 型主机) 邮局业务 普通邮局 企业邮箱 M 邮、环球即时邮、刺猬邮局、吉邮、 天珠邮局、即时邮、畅享邮 包销邮局 企业邮局 M 邮包销邮局、环球即时邮包销邮局、 即时邮包销邮局、畅享邮包销邮局 6.4. demo 在线演示系统 demo 演示地址:https://218.5.81.149/apidemo/index.php 登录账号:代理会员号 登录密码:代理会员号密码 6.5. 更新记录(changelog) 参看说明:https://218.5.81.149/apidemo/changelog/index.php 6.6. 注意事项 1. 本接口中 xml 报文对大小写敏感,在构造业务操作命令的时候请特别注意. 2. IDNs 多语种域名(CN、中国、网络、公司域名除外),请使用 punycode 转码进行相关业务 操作;

CN、中国、网络、公司域名请使用域名原码,无需转为 punycode 编码. API 用户使用手册 7. API 系统 7.1. 服务器交互 7.1.1. 联接服务器地址 API 正式服务器地址: cp.35.com 端口:30008 帐号:代理会员号 密码:代理会员号密码 API 测试服务器地址:218.5.81.149 端口:30008 帐号:150132 密码:Aa654123$ 7.1.2. 建立 TCP 连接 在与服务器进行任何交互操作前,都必须先进行联接(如果未建立联接的话). 与服务器建立联接,使用我司提供的服务器地址及端口建立 Tcp 连接,若连接成功,将收到服 务器返回客户端的 greeting 信息如下: client Greeting

1000 Your Connection with API Server is Successful 2009-02-16 06:22:21 客户端接收到 greeting 后就确认连接成功. 7.1.3. 建立会话(session)及登录(Login) 7.1.3.1. 命令格式 标签 描述/定义 业务请求: API 用户使用手册 CATEGORY 产品操作类型 CATEGORY:client ACTION 业务操作类型 ACTION:Login CLTRID 交易系列号,由客户产生,具唯一值,不得重复使用. CHKSUM md5(clid + md5(password) + cltrid + login ) 返回处理结果: CATEGORY CATEGORY:client ACTION ACTION:Login CODE 参考错误代码 msg 处理结果描述,参考错误代码 value 错误的对象或原因 cltrid 客户交易系列号,根据客户提交信息设置 svtrid 服务端交易系列号 chksum md5(clid + md5(password) + cltrid + svtrid + code + msg + value) 7.1.3.2. 功能说明 连接建立后,使用 Login 进行登陆,登陆时要使用正确的客户信息,当Login 成功后,即建立了 会话(session). 7.1.3.3. DEMO 使用说明 点击进入 https://218.5.81.149/apidemo/index.php ,如已登录,点击 Client->

Login. 7.1.3.4. 限制或者约束条件 用户名和密码必须是有效. 7.1.3.5. 备注 客户登陆后就可以向服务器提交操作,您可以在........