1、URL

HTTP API 地址是 ：https://todapi.now.cn:2443/

2、验证

所有发送的请求都需要如下验证参数：

auth-userid: 您当前的代理商账号 ID（查询您的代理 ID）

api-key: 一串用于认证 API 命令调用字母数字代码（阅读如下提示，查询您的 API Key）

注： auth-userid和api-key全部用get请求方式，接口业务参数请参见接口HTTP方式要求。

3、找到您的代理商ID，API Key，和授权IP

1.登录您的代理商控制面板

2.在左侧功能栏最上方代理号码：****写的一般是六到七位数字就是代理ID

3.在左侧功能栏找到“HTTP API接口管理”下面的“修改重置API KEY”，可以初使化生成API验证密码也就是API KEY，也可以在同一页面修改API密码

4.在左侧功能栏找到“HTTP API接口管理”下面的＂更改接口验证IP”，可以授权您要调用 接口的服务器IP进行授权，没有授权将无法使用接口

注意

重新生成一个新的 API Key 意味着您旧的 API Key 马上失效，这将会对您的现有 API验证失败

4、API

HTTP API 要求所有用于检索数据的请求应使用 GET 方法而提交，更改以及删除数据的请求应使用 POST方法。如果您没有使用正确的方法发送请求，那么特殊 HTTP 方法的请求则会返回错误值。然而，为了使您能够更简便地用浏览器及命令行工具测试 API，我们提供了测试 URL，让您能够使用 GET

1、描述

查询某一特定域名是否可注册

2、参数

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
domain-name	字符串数组	必填	需要查询的域名
tlds	字符串数组	必填	待查询域名的顶级域后缀

3、HTTP 方式

GET方式

4、测试 URL 请求范例

/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net

5、接口返回值 Top

返回一个 hash Map，其中包含所查询的顶级域名后缀的 availability status：

域名查询状态（status）

available -域名可以注册

unavailable-域名已经被注册

1、描述

利用提供的详细信息给域名添加联系人

2、参数

名称	数据类型	必填/可选	描述
auth	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
registrant-type	字符串	必填	I:个人 E:企业
name	字符串	必填	联系人名称(英文) (字符限制 255）
name-loc	字符串	必填	联系人名称(中文) (字符限制 255）
company	字符串	必填	公司名称(英文)（字符限制 255）
company-loc	字符串	必填	公司名称(中文)
email	字符串	必填	联系人 email 地址
address-line-1	字符串	必填	联系人地址第一行(英文)（字符限制64）
address-loc-line-1	字符串	必填	联系人地址第一行(中文)（字符限制64）
city	字符串	必填	城市名称英文或拼音（字符限制 64）
country	字符串	必填	国家代码参考 ISO 3166-1 alpha-2 （字符限制 2）
zipcode	字符串	必填	邮编 （字符限制 10）
mobile-cc	字符串	必填	电话国家代码 （字符限制 3）
mobile	字符串	必填	移动电话号码 （字符限制 15）
phone-cc	字符串	必填	电话国家代码 （字符限制 3）
phone	字符串	必填	电话号码 （字符限制 12）
address-line-2	字符串	可选	联系人地址第二行 （字符限制 64）
address-line-3	字符串	可选	联系人地址第三行 （字符限制 64）
state	字符串	必填	省份/州名称 英文或拼音（字符限制 64）
fax-cc	字符串	必填	传真国家代码 （字符限制 3）
fax	字符串	必填	传真号码 （字符限制 64）
ident-type	字符串	必填	证件类型 ?
ident-no	字符串	必填	证件号码
注：中文信息也可以写英文，但英文不可以写中文
注： 如果是HK域名请增加以下参数
type	字符串	必填	"HkContact"
attr-name1	字符串	必填	"ident_type"
attr-value1	字符串	必填	个人：CNID（国内身份证），PASSNO（护照），OTHIDV（其它个人） 企业：CNCO（组织机构代码证）,BR（香港商务登记证）,OTHORG（其他企业）
attr-name2	字符串	必填	"ident_number"
attr-value2	字符串	必填	所填写证件类型号码

3.HTTP 方法

POST

URL 请求范例

/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&name-loc=name-loc&company=company&company-loc=company-loc&email=urname@domain.com&address-line-1=address1&address-loc-line-1=address1-loc&city=city&country=nn&zipcode=0&phone-cc=0&phone=0

4.接口返回值

返回新添加的联系人的 Contact Id (整数值) 。不同类型的联系人可以使用相同的名称和公司名称

URL 请求范例

/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&name-loc=name-loc&company=company&company-loc=company-loc&email=urname@domain.com&address-line-1=address1&address-loc-line-1=address1-loc&city=city&country=nn&zipcode=0&phone-cc=0&phone=0

5.接口响应

返回新添加的联系人的联系人ID（Integer）

如遇到错误，会返回包含 ERROR和错误信息的状态值

1.描述

注册一个域名

2、参数

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
domain-name	字符串数组	必填	您需要注册的域名
years	整数	必填	您要注册的域名的年数
ns	Array of Strings	必填	域名的 DNS域名服务器
reg-contact-id	整数	必填	域名的 注册人联系 ID
admin-contact-id	整数	必填	域名的 管理联系人 ID
注：如域名为HK域名时，各项联系人ID不能相同，并增加以下参数（其他域名可使用相同联系人ID）
tech-contact-id	整数	必填	域名的 技术联系人 ID
billing-contact-id	整数	必填	域名的 账单联系人 ID

3.HTPP方式

POST

4.测试 URL 请求范例 Top

/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com ®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5.接口响应 Top

返回值如下：

域名注册订单 ID (entityid)：

域名服务器修改操作描述 (actiontypedesc)

域名服务器修改状态 (actionstatus)

域名服务器修改状态描述(actionstatusdesc)

如出现任何错误，状态会返回值为 Error 并附带一条错误信息

1、描述

获取已注册域名的ID

2、參数

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
domain-name	字符串	必填	想要获取 ID 的已注册域名

3、HTTP 方式

GET

4、测试 URL 请求范例

/api/domains/orderid.json?auth-userid=0&api-key=key&domain-name=domain.com

4、接口响应

返回已注册域名对应的ID（整数）

1、描述

通过特定的域名 ID 获取相关的 域名注册订单信息

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
order-id	整数	必填	需要获取信息的 域名注册订单的 ID
options	字符串数组	必填	值可设置为：All

3、HTTP 方式

GET

4、测试 URL 请求范例

/api/domains/details.json?auth-userid=0&api-key=key&order-id=0&options=All

5、接口响应

返回一个 hash map 包含域名注册订单的信息：

域名 ID (entityid)

域名 (domainname)

订单描述 (description)

目前的订单状态(currentstatus) (暂时未启用忽略)

域名状态(orderstatus)

订单生成日期（以注册局时间为准）(creationtime)

过期日期（以注册局时间为准） (endtime)

该订单是否只属于代理商账户下的某一客户 (isImmediateReseller) (暂时未启用忽略)

注册联系人 ID (registrantcontactid)

管理联系人 ID(admincontactid)

技术联系人 ID (techcontactid)

账单联系人 ID (billingcontactid)

域名服务器(ns1 and ns2)

1、描述

对于特定的 域名订单进行特定年数的续费操作

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
order-id	整数	必填	您想要续费的 域名订单号
years	整数	必填	您想要对该域名续费的年数
exp-date	整数	必填	订单现在的过期日，用 epoch time 格式

3、HTTP 方式

POST

4、测试 URL 请求范例

/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036

5、接口响应 Top

返回值如下：

域名注册订单 ID (entityid)

域名服务器修改操作描述 (actiontypedesc)

域名服务器修改状态 (actionstatus)

域名服务器修改状态描述(actionstatusdesc)

如出现任何错误，状态会返回值为 Error 并附带一条错误信息

1、描述

修改指定 域名订单的域名 dns 服务器

2、参数

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
order-id	整数	必填	需要获取信息的 域名注册订单的 ID
ns	字符串数组	必填	新的域名 dns 服务器

3、HTTP 方式

POST

4、测试 URL 请求范例

/api/domains/modify-ns.json?auth-userid=0&api-key=key&order-id=0&ns=ns1.domain.asia&ns=ns2.domain.asia

5、接口响应

返回值如下：

修改状态(actionstatus)

修改状态描述 (actiontypedesc)

域名注册订单的 ID(entityid)

是否成功(success)

如出现任何错误，状态会返回值为 Error 并附带一条错误信息

1、描述

修改特定域名订单的联系人信息

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
order-id	整数	必填	需要获取信息的 域名注册订单的 ID
reg-contact-id	整数	必填	新注册联系人 ID
admin-contact-id	整数	必填	新注册联系人 ID
tech-contact-id	整数	必填	新技术联系人 ID
billing-contact-id	整数	必填	新账单联系人 ID

3、HTTP 方式

POST

4、测试 URL 请求范例

/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5、接口响应

返回值如下：

域名注册订单 ID (entityid)

域名服务器修改操作描述 (actiontypedesc)

域名服务器修改状态 (actionstatus)

域名服务器修改状态描述(actionstatusdesc)

如出现任何错误，状态会返回值为 Error 并附带一条错误信息

1、描述

转移域名

注意 您必须确保域名已经解锁。

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
auth-key	字符串	必填	认证参数 API KEY
domain-name	字符串	必填	指定你要转移的域名
auth-code	字符串	必填	您要转移的域名的授权码(也叫 转移密码)
reg-contact-id	整数	必填
admin-contact-id	整数	必填
tech-contact-id	整数	必填
billing-contact-id	整数	必填

3、HTTP 方式

POST

4、测试 URL 请求范例

/api/domains/transfer.json?auth-userid=0&api-key=key&order-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5、接口响应

返回值如下：

域名提交转入状态 (status)

返回信息 (message)

如出现任何错误，状态会返回值为 Error 并附带一条错误信息

1、描述

为正在转入时代互联的域名提交域名转移码（也称之为授权码）

注意 您必须确保域名已经解锁。

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	认证参数 API KEY
order-id	整数	必填	转入域名的订单 ID
auth-code	字符串	必填	转入域名的转移码或授权码

3、HTTP 方式

GET

4、测试 URL 请求范例

/api/domains/transfer/submit-auth-code.xml?auth-userid=0&api-key=0&order-id=12345678&auth-code=authcodegoeshere

5、接口响应

如提供的授权码为正确的，将返回值 success（字符串），域名转入进程将会继续。如出现任何错误信息，将会返回状态值为 Error，和具体的错误信息

1、描述

查询域名转移结果

2、参数 Top

名称	数据类型	必选/可选	描述
order-id	整数	必填	订单id

3、HTTP 方式

POST

4、测试 URL 请求范例

/api/domains/query-transfer?order-id=12345678

5、接口响应

返回值如下：

{"trStatus":"pending"}

1、描述

实名认证提交接口可支持需要实名认证域名提交实名

2、参数 Top

名称	数据类型	必选/可选	描述
tld	字符串	必填	待查询域名的顶级域后缀 (例如:cn com cc等暂时只支持cn)
contact-id	整数	必填	已经建立好的需提交实名认证的联系人id
ident-type	字符串	必填	证件类型 ?
ident-no	字符串	必填	证件号码
ident-image-base64	字符串	必填	采用Base64编码的实名认证资料图片(base64编码后要小于于200KB 否则会返回413 Request Entity Too Large)
ident-ext-image-base64	字符串	非必填	采用Base64编码的实海外自然人承诺书(下载)，只有所有者为非中国国内个人所有者时才需要提交

3、HTTP 方式

POST

4、测试 URL 请求范例

/api/contacts/real-name-submit.json?tld=com&contact-id=12345678&ident-type=JGZ&ident-no=11111&ident-image-base64=4541564646

5、接口响应

返回值如下：

联系人 ID (entityid)

提交域名后缀 (tld)

实名提交状态 (status)

1、描述

实名结果查询

2、参数 Top

名称	数据类型	必选/可选	描述
tld	字符串	必填	待查询域名的顶级域后缀 (例如:cn com cc等暂时只支持cn)
contact-id	整数	必填	已经建立好的需提交实名认证的联系人id

3、HTTP 方式

POST

4、测试 URL 请求范例

/api/contacts/real-name-query.json?tld=com&contact-id=12345678

5、接口响应

返回值如下：

联系人 ID (entityid)

域名后缀 (tld)

实名状态 (status)

1、描述

查询代理商余额

2、参数 Top

名称	数据类型	必选/可选	描述
username	字符串	必填	用户名
password	字符串	必填	密码

3、HTTP 方式

GET

4、测试 URL 请求范例

/api/billing/balance.json

5、接口响应

返回值如下：

{"balance":0.00}

1、描述

域名命名审核查询

2、参数 Top

名称	数据类型	必选/可选	描述
order-id	整数	必填	订单id

3、HTTP 方式

POST

4、测试 URL 请求范例

/domains/query-domain-real-name?order-id=12345678

5、接口响应

返回值如下：

{status:"pass"}

1、描述

给所属域名下的子域名登记DNS服务器，支持IPv6

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
orderid	整数	必填	域名ID
host	字符串	必填	子域名
ips	字符串	必填	IPv4或IPv6（可多个）

3、HTTP 方式

GET

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/domains/createNS.json?auth-userid=0&api-key=key&orderid=113502496&host=abc&ips=8.8.8.8&ips=9.9.9.9

5、接口响应

返回值如下：

返回json字符串
操作成功：
success：true
操作失败：
success：false 或 status：ERROR
提示信息
message：信息

1、描述

修改所属域名下子域名的DNS服务器，支持IPv6，原DNS服务器将被全部删除

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
orderid	整数	必填	域名ID
host	字符串	必填	子域名
newips	字符串	必填	新IP，IPv4或IPv6（可多个）

3、HTTP 方式

GET

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/domains/updateNS.json?auth-userid=0&api-key=key&orderid=113502496&host=abc&newips=6.6.6.6&newips=7.7.7.7

5、接口响应

返回值如下：

返回json字符串
操作成功：
success：true
操作失败：
success：false 或 status：ERROR
提示信息
message：信息

1、描述

删除所属域名下子域名的全部DNS服务器

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
orderid	整数	必填	域名ID
host	字符串	必填	子域名

3、HTTP 方式

GET、POST

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/domains/deleteNS.json?auth-userid=0&api-key=key&order-id=113502496&host=abc

5、接口响应

返回值如下：

返回json字符串
操作成功：
success：true
操作失败：
success：false 或 status：ERROR
提示信息
message：信息

1、描述

查询域名下的解析列表

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
Domain	字符串	必填	域名
currentPage	字符串	选填	当前页码
pageSize	字符串	选填	每页数量 最大500

3、HTTP 方式

GET、POST

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/dns/describe-record-index.json?auth-userid=0&api-key=key&Domain=c.com

5、接口响应

返回值如下：

返回json字符串
操作成功：
{"RequestId":"6fa71dfc-4d68-485a-8134-3720502b3dd4","Data":[{"id":1,"domain":"test.com","host":"s03","type":"A","value":"127.0.0.1","ttl":600,"mx":0,"state":0,"line":"","remark":null}],"Pagination":{"current":1,"pageSize":20,"total":12}}
state描述 0: '正常', 2: '暂停',3: '管理员暂停',4': '待审核',5: '不通过',
添加URL转发的解析需要通过审核才可添加成功

操作失败：
success：false 或 status：ERROR
提示信息
message：信息

1、描述

添加所属域名的单条解析

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
Domain	字符串	必填	域名
Host	字符串	选填	主机头,不填默认为@
Type	字符串	选填	主机类型,不填默认为A,允许值: "A", "CNAME", "TXT", "MX", "SRV", "CAA", "REDIRECT_URL", "FORWARD_URL"
Value	字符串	必填	主机值
Mx	字符串	必填	MX记录优先值 取值范围：[1,50]
Ttl	字符串	必填	ttl,最低不得低于600

3、HTTP 方式

GET、POST

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/dns/add-domain-record.json?auth-userid=0&api-key=key&Domain=1&Host=s04&Mx=&Ttl=600&Type=A&Value=127.0.0.2

5、接口响应

返回值如下：

返回json字符串
操作成功：
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b","Id":9919432}
操作失败：
success：false 或 status：ERROR
提示信息
message：信息

1、描述

修改所属域名下的解析

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
Id	字符串	必填	解析记录ID
Host	字符串	选填	主机头,不填默认为@
Type	字符串	选填	主机类型,不填默认为A,允许值: "A", "CNAME", "TXT", "MX", "SRV", "CAA", "REDIRECT_URL", "FORWARD_URL"
Value	字符串	必填	主机值
Mx	字符串	必填	MX记录优先值 取值范围：[1,50]
Ttl	字符串	必填	ttl,最低不得低于600

3、HTTP 方式

GET、POST

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/dns/update-domain-record.json?auth-userid=0&api-key=key&Id=1&Host=s04&Mx=&Ttl=600&Type=A&Value=127.0.0.2

5、接口响应

返回值如下：

返回json字符串
操作成功：
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
操作失败：
success：false 或 status：ERROR
提示信息
message：信息

1、描述

删除所属域名下的单条解析

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
Id	字符串	必填	解析记录ID

3、HTTP 方式

GET、POST

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/dns/delete-domain-record.json?auth-userid=0&api-key=key&Id=1

5、接口响应

返回值如下：

返回json字符串
操作成功：
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
操作失败：
success：false 或 status：ERROR
提示信息
message：信息

1、描述

删除所属域名下的单条解析

2、参数 Top

名称	数据类型	必选/可选	描述
auth-userid	整数	必填	认证参数 代理商 ID
api-key	字符串	必填	Authentication Parameter 认证参数 API KEY
Id	字符串	必填	解析记录ID
Status	字符串	必填	解析记录状态。取值：Enable: 启用解析 Disable: 暂停解析

3、HTTP 方式

GET、POST

4、测试 URL 请求范例

https://todapi.now.cn:2443/api/dns/set-domain-record-status.json?auth-userid=0&api-key=key&Id=1&Status=Enable

5、接口响应

返回值如下：

返回json字符串
操作成功：
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
操作失败：
success：false 或 status：ERROR
提示信息
message：信息