西部数码域名业务API文档 V2.0 2019.5.6 （最新域名全业务接口文档，涵盖所有域名管理功能）
锐菱小石头
阅读：1626
2020-02-20 13:31:01
评论：0
一、文档说明
1.1、文档简介
欢迎使用西部数码域名API，您可以使用本文档介绍的 API 对域名进行相关操作。
1、使用限制：
1)、只有西部数码正式代理合作伙伴才能使用API功能。
2)、您需要提供正确的身份验证信息才能使用API功能，身份验证信息使用公共参数传递，关于身份验证详细信息详见 1.2节。
3)、API文档涉及我司API相关敏感信息，请勿随意传播。
2、服务地址：https://api.west.cn/api/v2，仅支持HTTPS通道。
3、所有请求及返回数据均使用GB2312进行编码。
4、一分钟内最大允许请求接口300次，否则将被限制请求频率。
1.2、身份验证
本节所述身份验证方式适用于除“4.10、上传域名实名资料”而外的所有API。（上传域名实名资料验证方式见4.10接口说明）
所有API均需要传递该身份认证参数，以便验证调用者身份，其中GET请求使用GET方式传递，POST请求使用POST方式传递，参数名称为token。
身份验证串有效期为10分钟。
身份验证参数token使用如下的方式生成：
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| token | string | 身份验证字符串，取值为：md5(username+api_password+timestamp)，其中： username：您在西部数码注册的用户名。 api_password：您设置的API密码。您可登录西部数码官网(https://www.west.cn)后台，在“代理商管理”->"API接口配置"页面查看您的api密码。 timestamp：当前时间的毫秒时间戳。 将字符串username与字符串api_password连接，再与timestamp连接，然后将生成的字符串进行md5求值，md5算法要求为： 32位16进制字符串，小写格式。 身份验证串有效期10分钟。 比如，您的西部数码用户名为：zhangsan，您的API密码为：5dh232kfg!* ,当前毫秒时间戳为：1554691950854，则： token = md5(zhangsan + 5dh232kfg!* + 1554691950854) = f17581fb2535b2a7ee4468eb3f96a2a9 |
1.3、公共参数说明
本文档所涉及API（除"4.10 上传域名实名资料"外）在调用时均需要传递以下公共参数：
公共参数
| 名称 | 类型 | 备注 |
|---|---|---|
| username | string | 用户名（接口使用者在西部数码注册的用户名） |
| time | number | 当前时间毫秒时间戳 |
| token | string | 身份验证串（请按 1.2节 说明生成） |
1.4、统一返回说明
本文档所涉及API的数据返回均为JSON字符串格式，JSON数据结构如下表所示：
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
|---|---|---|---|---|
| result | number | 必须 | 返回代码 200 成功 非200失败 | |
| clientid | string | 必须 | 请求识别码 | |
| msg | string | 非必须 | 失败/成功返回的文本信息 | |
| errcode | number | 非必须 | 错误码（错误码含义详见 附录7.1 错误码说明） | |
| data | object | 非必须 | 成功返回数据(具体以各API返回数据说明为准) |
以下各API接口返回数据部分，除data字段各API不同外，其他字段均通用，后面各API返回信息中可能不再针对除data字段外的其它字段做特殊说明
1.5、联调环境说明
本API系统不提供独立的API联调环境，调试环境与正式环境一致,但为了便于程序开发与测试，提供了一个特殊的域名"test.com",
可以用此特殊域名进行相关测试操作，注册及续费均不涉及费用。
此外在联调期间，也可以联系我司专员协助注册其它正式com/cn域名进行相关测试操作，注册后3日内我司专员将删除域名，此操作也不涉及费用。
1.6、技术支持
如对本API文档有疑问，请联系邮箱 ：weiyanlover@west.cn
示例代码 ：点击下载
二、获取账户余额、域名价格
2.1、获取账户可用余额
基本信息
请求地址： /info/?act=checkbalance
Method： GET
接口描述：
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 返回值 | ||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ balance | number | 非必须 | 可用余额 |
2.2、 获取域名价格
基本信息
请求地址： /info/?act=getprice
Method： POST
接口描述：
多年价格计算: 购买价格+(n-1)*续费价格
注:本接口只返回普通域名
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| type | string | 是 | domain | 固定为：domain |
| value | string | 是 | west.cn | 任意该类别的域名，如test.com |
| year | number | 否 | 1 | 开通年限 1-10 默认为1 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ buyprice | number | 非必须 | 购买价格 | ||
| ├─ renewprice | number | 非必须 | 续费价格 | ||
| ├─ buyyear | number | 非必须 | 购买时长 |
三、域名管理
3.1、域名查询
基本信息
请求地址： /domain/query/
Method： POST
接口描述：
域名查询接口
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west | 域名1个中文或英文参数（中文域名同时支持汉字及punycode转码） |
| suffix | string | 是 | .com/.net | 1-N个后缀用英文逗号分隔 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| msg | string | 非必须 | |||
| clientid | string | 必须 | |||
| data | object [] | 非必须 | |||
| ├─ avail | number | 必须 | 是否可以注册(0--不允许,1--允许) | ||
| ├─ name | string | 必须 | 域名 | ||
| ├─ type | string | 非必须 | 溢价域名显示类型 | ||
| ├─ price | number | 非必须 | 溢价域名价格 |
3.2、域名续费
基本信息
请求地址： /domain/?act=renew
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 续费域名 |
| year | number | 是 | 1 | 续费时间 |
| expiredate | string | 是 | 2018-12-21 12:00:00 | 域名当前到期时间，防止重复续费 |
| client_price | number | 是 | 9999 | 域名续费价格.低于成本会禁止操作 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 |
3.3、获取域名列表
基本信息
请求地址： /domain/?act=getdomains
请求方式： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| limit | 否 | 20 | 每页大小 |
| pageno | 否 | 1 | 默认第几页 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ items | object [] | 非必须 | |||
| ├─ domain | string | 必须 | 域名 | ||
| ├─ regdate | string | 必须 | 注册时间 | ||
| ├─ expdate | string | 必须 | 到期时间 | ||
| ├─ dns1 | string | 必须 | 主dns | ||
| ├─ dns2 | string | 必须 | 输dns | ||
| ├─ year | number | 必须 | 注册年数 | ||
| ├─ limit | number | 非必须 | 每页大小 | ||
| ├─ total | number | 非必须 | 总记录 | ||
| ├─ pageno | number | 非必须 | 当前页数 | ||
| ├─ totalpages | number | 非必须 | 总页数 |
3.4、获取域名管理密码
基本信息
请求地址： /domain/?act=getpwd
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 待查询域名 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ domainpwd | string | 必须 | 管理密码 |
3.5、修改域名管理密码
基本信息
请求地址： /domain/?act=modpwd
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名 |
| domainpwd | string | 是 | password | 密码长度限制8位以上 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 操作码 | ||
| clientid | string | 必须 |
3.6、修改域名DNS
基本信息
Path： /domain/?act=moddns
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | text | 是 | west.cn | 待修改DNS域名 |
| dns1 | text | 是 | ns1.myhostadmin.net | 主dns |
| dns2 | text | 是 | ns2.myhostadmin.net | 辅dns |
| dns3 | text | 否 | ||
| dns4 | text | 否 | ||
| dns5 | text | 否 | ||
| dns6 | text | 否 | ||
| offline | text | 否 | 1 | 当参数为1时,domain可以传多个参数用逗号分隔,最多500个域名 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 |
3.7、添加域名解析
基本信息
请求地址： /domain/?act=adddnsrecord
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名 |
| host | string | 是 | @ | 主机名称 |
| type | string | 是 | A | 解析类型 限 A,CNAME,MX,TXT,AAAA,SRV |
| value | string | 是 | 127.0.0.1 | 解析值 |
| ttl | number | 是 | 900 | 解析生效时间值 60~86400 单位秒 (默认900) |
| level | number | 是 | 10 | 优先级别 1-100 默认(10) |
| line | string | 否 | 线路: 必须先添加默认线程后才能添加其它线路(默认="" ,电信="LTEL" ,联通="LCNC" ,移动="LMOB" ,教育网="LEDU" ,搜索引擎="LSEO") |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ id | number | 必须 | dns记录编号 |
3.8、修改域名解析
基本信息
请求地址： /domain/?act=moddnsrecord
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名 |
| id | number | 是 | 111111 | 解析记录编号 |
| value | string | 是 | 127.0.0.1 | 解析值 |
| ttl | number | 是 | 900 | 解析生效时间值 60~86400 单位秒 (默认900) |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 |
3.9、删除域名解析
基本信息
请求地址： /domain/?act=deldnsrecord
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名 |
| id | number | 是 | 11 | 解析记录ID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 |
3.10、获取域名解析记录
基本信息
请求地址： /domain/?act=getdnsrecord
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名 |
| limit | number | 否 | 20 | 每页大小默认20 |
| pageno | number | 否 | 1 | 第几页 默认为1 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ items | object [] | 非必须 | |||
| ├─ id | number | 必须 | 记录编号,修改时必填 | ||
| ├─host | string | 必须 | 主机名称 | ||
| ├─value | string | 必须 | 解析值 | ||
| ├─type | string | 必须 | 解析类型 限 A,CNAME,MX,TXT,AAAA,SRV | ||
| ├─level | number | 必须 | 优先级别 1-100 默认(10) | ||
| ├─ ttl | number | 必须 | 解析生效时间值 60~86400 单位秒 (默认900) | ||
| ├─line | string | 必须 | 线路: 必须先添加默认线程后才能添加其它线路(默认="" ,电信="LTEL" ,联通="LCNC" ,移动="LMOB" ,教育网="LEDU" ,搜索引擎="LSEO") | ||
| ├─pause | number | 必须 | 是否暂停(0--正常,1--暂停) | ||
| ├─ limit | number | 非必须 | 每页数量 | ||
| ├─ total | number | 非必须 | 总记录数 | ||
| ├─pageno | number | 非必须 | 当前页数 | ||
| ├─totalpages | number | 非必须 | 总页数 |
3.11、获取域名证书
基本信息
Path： /domain/?act=cert
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| domain | 是 | west.cn |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | |||
| clientid | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ certurl | string | 非必须 | 域名证书URL地址.请自行存为图片 |
3.12、设置域名锁定状态
基本信息
Path： /domain/?act=setlock
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| domain | 是 | west.cn | |
| val | 是 | 1 | 0--解锁 ,1--锁定 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | 200成功 | ||
| clientid | string | 非必须 |
3.13、获取whois信息
基本信息
Path： /domain/?act=whois
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| domain | 是 | west.cn |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | |||
| clientid | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ code | number | 非必须 | 200 获取成功 | ||
| ├─ regdate | string | 非必须 | 注册时间 | ||
| ├─ expdate | string | 非必须 | 到期时间 | ||
| ├─ status | string | 非必须 | 状态 | ||
| ├─ dom_org | string | 非必须 | 所有者 | ||
| ├─ registrar | string | 非必须 | 注册商 | ||
| ├─ dom_em | string | 非必须 | 所有者邮箱 | ||
| ├─ nameserver | string | 非必须 | DNS | ||
| ├─ bizserver | string | 非必须 | |||
| ├─ body | string | 非必须 | 详细 |
3.14、获取域名续费价格
基本信息
Path： /domain/?act=getrenprice
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| domain | 是 | west.cn | |
| year | 是 | 1 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | |||
| clientid | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ price | number | 非必须 | 续费价格(成本) | ||
| ├─ year | string | 非必须 | 续费年限 |
3.15、获取离线记录
基本信息
Path： /domain/?act=offline
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| domain | 是 | 1 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | |||
| clientid | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ strdomain | string | 非必须 | 域名 | ||
| ├─ action | string | 非必须 | |||
| ├─ status | number | 非必须 | 0--未开始1--队列中;2--执行完成 | ||
| ├─ rcode | string | 非必须 | 200 ok为成功 其它失败 | ||
| ├─ addtime | string | 非必须 | 添加时间 | ||
| ├─ uptime | string | 非必须 | 执行时间 |
四、域名模板及注册
4.1、创建模板
基本信息
请求地址： /audit/?act=auditsub
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| c_regtype | string | 是 | E | 所有者类型,个人:I ,企业:E |
| c_org_m | string | 否 | 成都西维数码有限公司 | (中文)所有者单位名称.如果是创建模板当c_regtype为E时为必填项 |
| c_ln_m | string | 是 | 李 | (中文)联系人姓 |
| c_fn_m | string | 是 | 小明 | (中文)联系人名 |
| c_co | string | 是 | CN | 所属国家或地区简称;CN: 中国;US: 美国;详见附录 |
| cocode | string | 是 | +86 | 国家或地区电话代码;+86: 中国;+1: 美国;详见附录 |
| c_st_m | string | 是 | 四川 | (中文)所属省 |
| c_ct_m | string | 是 | 成都 | (中文)所属市 |
| c_dt_m | string | 否 | 金牛区 | (中文)所属县 |
| c_adr_m | string | 是 | 一环路北一段99号 | (中文)通讯地址 |
| c_pc | string | 是 | 610031 | 邮编 |
| c_ph_type | number | 是 | 0 | 联系电话类型(数字);0:手机;1:座机 |
| c_ph | string | 否 | 13888888888 | 手机号码;当c_ph_type为0时,此项必填 |
| c_ph_code | string | 否 | 028 | 座机号码区号;当c_ph_type为1时,此项必填 |
| c_ph_num | string | 否 | 62778877 | 座机号码;当c_ph_type为1时,此项必填 |
| c_ph_fj | string | 否 | 123 | 座机号码分机号;当c_ph_type为1时选填 |
| c_em | string | 是 | 12346@myemail.com | 所有者电子邮箱 |
| c_org | string | 否 | Chengdu west dimension digital technology Co., LTD | (英文)所有者单位名称;如果c_regtype为E时,此项必填 |
| c_ln | string | 是 | li | (英文)联系人 |
| c_fn | string | 是 | xiao ming | (英文)联系人名 |
| c_st | string | 是 | shi chuan | (英文)省份 |
| c_ct | string | 是 | cheng du | (英文)城市 |
| c_adr | string | 是 | shi chuan cheng du yi huang lu 99 hao | (英文)通讯地址 |
| reg_contact_type | string | 否 | hk,gswl | 适用范围;如果需要支持hk域名或特殊中文域名,此项必填;hk:支持hk域名注册及过户;gswl:支持特殊中文域名注册及过户 ;hk,gswl:同时支持hk域名和特殊中文域名,逗号分隔 |
| c_idtype_hk | string | 否 | ORG | hk域名证件类型;如果需要支持hk域名,此项必填;当c_regtype为E时需要下面值的其中之一:ORG: 组织机构代码证;CI: 营业执照;BR: 香港公司登记证，当c_regtype为I时需要下面值的其中之一:OTHID: 大陆身份证;HKID: 香港身份证;PASSNO: 护照号码;BIRTHCERT: 出生证明 |
| c_idnum_hk | string | 否 | 12345678 | hk域名证件号码;如果需要支持hk域名,此项必填;与c_idtype_hk对应 |
| c_idtype_gswl | string | 否 | ORG | 特殊中文域名证件类型;如果需要支持特殊中文域名,此项必填;当c_regtype为I或E时需要下面值的其中之一;SFZ: 大陆身份证;ORG: 组织机构代码证 |
| c_idnum_gswl | string | 否 | 12345678 | 特殊中文域名证件号码;如果需要支持特殊中文域名,此项必填;与c_idtype_gswl对应 |
| c_keyword | string | 否 | 调用标识,创建成功后原样返回给调用者,方便调用者区分数据 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | object | 非必须 | 返回数据 | ||
| ├─ c_sysid | number | 必须 | 模板标识 | ||
| ├─ c_keyword | string | 非必须 | 调用标识 | ||
| msg | string | 非必须 | 出错信息 | ||
| errcode | number | 非必须 | 错误码 |
4.2、修改模板
基本信息
请求地址： /audit/?act=auditmod
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| c_sysid | string | 是 | 123 | 模板标识 |
| c_co | string | 是 | CN | 所属国家简称;CN: 中国;US: 美国 |
| cocode | string | 是 | +86 | 国家电话代码;+86: 中国,+1: 美国;详见附录 |
| c_st_m | string | 是 | 四川 | (中文)所属省 |
| c_ct_m | string | 是 | 成都 | (中文)所属市 |
| c_dt_m | string | 否 | 金牛区 | (中文)所属县 |
| c_adr_m | string | 是 | 一环路北一段99号 | (中文)通讯地址 |
| c_pc | string | 是 | 610031 | 邮编 |
| c_ph_type | number | 是 | 0 | 联系电话类型(数字);0:手机;1:座机 |
| c_ph | string | 否 | 13888888888 | 手机号码;当c_ph_type为0时,此项必填 |
| c_ph_code | string | 否 | 028 | 座机号码区号;当c_ph_type为1时,此项必填 |
| c_ph_num | string | 否 | 62778877 | 座机号码;当c_ph_type为1时,此项必填 |
| c_ph_fj | string | 否 | 123 | 座机号码分机号;当c_ph_type为1时选填 |
| c_em | string | 是 | 12346@myemail.com | 所有者电子邮箱 |
| c_st | string | 是 | shi chuan | (英文)省份 |
| c_ct | string | 是 | cheng du | (英文)城市 |
| c_adr | string | 是 | shi chuan cheng du yi huang lu 99 hao | (英文)通讯地址 |
| reg_contact_type | string | 否 | hk,gswl | 适用范围;如果需要支持hk域名或特殊中文域名,此项必填;hk:支持hk域名注册及过户;gswl:支持特殊中文域名注册及过户 ;hk,gswl:同时支持hk域名和特殊中文域名,逗号分隔 |
| c_idtype_hk | string | 否 | ORG | hk域名证件类型;如果需要支持hk域名,此项必填;当c_regtype为E时需要下面值的其中之一:ORG: 组织机构代码证;CI: 营业执照;BR: 香港公司登记证，当c_regtype为I时需要下面值的其中之一:OTHID: 大陆身份证;HKID: 香港身份证;PASSNO: 护照号码;BIRTHCERT: 出生证明 |
| c_idnum_hk | string | 否 | 12345678 | hk域名证件号码;如果需要支持hk域名,此项必填;与c_idtype_hk对应 |
| c_idtype_gswl | string | 否 | ORG | 特殊中文域名证件类型;如果需要支持特殊中文域名,此项必填;当c_regtype为I或E时需要下面值的其中之一;SFZ: 大陆身份证;ORG: 组织机构代码证 |
| c_idnum_gswl | string | 否 | 12345678 | 特殊中文域名证件号码;如果需要支持特殊中文域名,此项必填;与c_idtype_gswl对应 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | object | 非必须 | 返回数据 | ||
| ├─ c_sysid | number | 必须 | 模板标识 | ||
| msg | string | 非必须 | 出错信息 | ||
| errcode | number | 非必须 | 错误码 |
4.3、删除模板
基本信息
请求地址： /audit/?act=auditdel
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| c_sysid | number | 是 | 123 | 模板标识 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| msg | string | 非必须 | 出错信息 | ||
| errcode | number | 非必须 | 错误码 |
4.4、批量获取模板列表
基本信息
请求地址： /audit/?act=auditlist
请求方式： POST
接口描述：
批量获取模板列表1分钟内最大允许请求50次,调用时请考滤本地存储信息或是缓存状态。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| c_keyword | string | 否 | 创建时录入的调用标识 | |
| c_regtype | string | 否 | E | 所有者类型，I:个人，E:企业/组织 |
| c_org_m | string | 否 | 所有者单位名称、所有者姓名 | |
| reg_contact_type | string | 否 | 适用范围;cg: 支持常规域名,hk: 支持hk域名,gswl:支持特殊中文域名 | |
| c_em | string | 否 | 所有者电子邮箱 | |
| c_status | number | 否 | 初审状态;详见附录 | |
| r_status | number | 否 | 实名状态;详见附录 | |
| c_date_begin | string | 否 | 模板创建开始时间 yyyy-MM-dd HH:mm:ss | |
| c_date_end | string | 否 | 模板创建结束时间 yyyy-MM-dd HH:mm:ss | |
| pageno | number | 否 | 1 | 页码;默认第一页 |
| pagesize | number | 否 | 20 | 每页条数;默认每页20条 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | object | 非必须 | 返回数据 | ||
| ├─ info | object [] | 必须 | |||
| ├─ c_sysid | number | 必须 | id标识 | ||
| ├─ c_org_m | string | 必须 | (中文)所有者名称 | ||
| ├─ c_fn_m | string | 必须 | (中文)联系人名 | ||
| ├─ c_ln_m | string | 必须 | (中文)联系人姓 | ||
| ├─ c_adr_m | string | 必须 | (中文)通讯地址 | ||
| ├─ c_st_m | string | 必须 | (中文)所属省 | ||
| ├─ c_ct_m | string | 必须 | (中文)所属市 | ||
| ├─ c_pc | string | 必须 | 邮编 | ||
| ├─ c_ph_all | string | 必须 | 手机/座机号码 | ||
| ├─ c_em | string | 必须 | 所有者电子邮箱 | ||
| ├─ c_org | string | 必须 | (英文)所有者单位名称 | ||
| ├─ c_fn | string | 必须 | (英文)联系人名 | ||
| ├─ c_ln | string | 必须 | (英文)联系人 | ||
| ├─ c_adr | string | 必须 | (英文)通讯地址 | ||
| ├─ c_st | string | 必须 | (英文)省份 | ||
| ├─ c_ct | string | 必须 | (英文)市 | ||
| ├─ c_co | string | 必须 | 所属国家或地区简称 | ||
| ├─ c_status | number | 必须 | 初审状态 | ||
| ├─ r_status | number | 必须 | 实名状态 | ||
| ├─ c_regtype | string | 必须 | 所有者类型 | ||
| ├─ c_date | string | 必须 | 创建时间 | ||
| ├─ c_keyword | string | 非必须 | 创建时录入的调用标识 | ||
| ├─ pagelist | object | 必须 | 分页数据 | ||
| ├─ pagecount | number | 必须 | 总页数 | ||
| ├─ total | number | 必须 | 总记录数 | ||
| ├─ pageno | number | 必须 | 当前页码 | ||
| ├─ limit | number | 必须 | 每页记录数 | ||
| msg | string | 非必须 | 出错信息 | ||
| errcode | number | 非必须 | 错误码 |
4.5、获取模板信息
基本信息
请求地址： /audit/?act=auditinfo
请求方式： POST
接口描述：
1.由于安全问题,本接口不允许获取实名的图片
2.同一个模板信息5分钟内最大允许获取5次，超出限制将暂停该接口5分钟，调用时请考滤本地存储信息或是缓存状态。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| c_sysid | number | 是 | 123 | 模板标识 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | object | 非必须 | 返回数据 | ||
| ├─ c_sysid | number | 必须 | 模板标识 | ||
| ├─ c_org_m | string | 必须 | 所有者 | ||
| ├─ c_fn_m | string | 必须 | 联系人名 | ||
| ├─ c_ln_m | string | 必须 | 联系人姓 | ||
| ├─ c_em | string | 必须 | 所有者邮箱 | ||
| ├─ c_status | number | 必须 | 初审状态（详见7.3） | ||
| ├─ r_status | number | 必须 | 实名状态（详见7.3） | ||
| ├─ c_regtype | string | 必须 | 所有者类型 | ||
| ├─ failinfo | string | 非必须 | 初审历史拒绝原因 | ||
| ├─ r_failinfo | string | 非必须 | 实名历史拒绝原因 | ||
| ├─ orgfile | object | 非必须 | 所有者资料 | ||
| ├─ f_sysid | number | 必须 | 资料标识 | ||
| ├─ f_type | number | 必须 | 证件类型（详见附录） | ||
| ├─ f_code | string | 必须 | 证件号码 | ||
| ├─ f_date | string | 必须 | 资料修改时间 | ||
| ├─ lxrfile | object | 非必须 | 联系人资料 | ||
| ├─ f_sysid | string | 必须 | 资料标识 | ||
| ├─ f_type | number | 必须 | 证件类型（详见附录） | ||
| ├─ f_code | string | 必须 | 证件号码 | ||
| ├─ f_date | string | 必须 | 资料修改时间 | ||
| msg | string | 非必须 | 出错信息 | ||
| errcode | number | 非必须 | 错误码 |
4.6、注册域名
基本信息
请求地址： /audit/?act=regdomain
请求方式： POST
接口描述：
{"result":"200","data":{"xxx.com":"注册失败原因...","xxx.cn":200}}
result=200表示命令提交成功,并不代表域名注册成功
data里的数据为每个域名的注册状态,200即为为成功,否则为失败原因~~~~
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | xxx.com,xxx.cn | 注册域名,多个域名英文逗号分隔,最大100个 |
| regyear | number | 是 | 1 | 注册年限 |
| domainpwd | string | 否 | 域名密码,不填则系统随机生成 | |
| dns_host1 | string | 否 | ns1.myhostadmin.net | 主DNS |
| dns_host2 | string | 否 | ns2.myhostadmin.net | 辅DNS |
| c_sysid | number | 是 | 123 | 模板标识 |
| client_price | string | 否 | 9 | 价格保护;代理商用户购买价，当价格低于自己的成本时，开通会失败，防止亏损,如不需要保护请不加该项 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | object | 必须 | 返回数据 | ||
| ├─ xxxx.com | string | 必须 | 注册的域名,值为200注册成功,其它则是失败原因 | ||
| msg | string | 必须 | 出错信息 | ||
| errcode | number | 必须 | 错误码 |
4.7、修改域名信息
基本信息
请求地址： /audit/?act=domainmodisub
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | xxx.com | 域名 |
| eppidtype | string | 是 | dom_id | 修改对象;dom_id:所有者;admin_id:管理联系人;tech_id:技术联系人;bill_id:缴费联系人;只能输入其中一项,不支持多项 |
| c_ln_m | string | 是 | 李 | (中文)联系人姓 |
| c_fn_m | string | 是 | 小明 | (中文)联系人名 |
| c_co | string | 是 | CN | 所属国家简称;CN: 中国,US: 美国;详见附录 |
| cocode | string | 是 | +86 | 国家电话代码;+86: 中国,+1: 美国;详见附录 |
| c_st_m | string | 是 | 四川 | (中文)所属省 |
| c_ct_m | string | 是 | 成都 | (中文)所属市 |
| c_dt_m | string | 否 | 金牛区 | (中文)所属县 |
| c_adr_m | string | 是 | 一环路北一段99号 | (中文)通讯地址 |
| c_pc | string | 是 | 610031 | 邮编 |
| c_ph_type | number | 是 | 0 | 联系电话类型(数字):0:手机,1:座机 |
| c_ph | string | 否 | 13888888888 | 手机号码;当c_ph_type为0时,此项必填 |
| c_ph_code | string | 否 | 028 | 座机号码区号;当c_ph_type为1时,此项必填 |
| c_ph_num | string | 否 | 62778877 | 座机号码;当c_ph_type为1时,此项必填 |
| c_ph_fj | string | 否 | 123 | 座机号码分机号;当c_ph_type为1时选填 |
| c_em | string | 是 | 12346@myemail.com | 所有者电子邮箱 |
| c_ln | string | 是 | li | (英文)联系人 |
| c_fn | string | 是 | xiao ming | (英文)联系人名 |
| c_st | string | 是 | shi chuan | (英文)省份 |
| c_ct | string | 是 | cheng du | (英文)城市 |
| c_adr | string | 是 | shi chuan cheng du yi huang lu 99 hao | (英文)通讯地址 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| msg | string | 必须 | 出错信息 | ||
| errcode | number | 必须 | 错误码 |
4.8、获取域名信息
基本信息
请求地址： /audit/?act=domaininfo
请求方式： POST
接口描述：
1.由于安全问题,本接口不允许获取实名的图片
2.同一个域名信息5分钟内最大允许获取5次，超出限制将暂停该接口5分钟，调用时请考滤本地存储信息或是缓存状态。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | test.com | 域名 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 | |||
| data | object | 非必须 | |||
| ├─ domain | string | 非必须 | 域名 | ||
| ├─ c_sysid | number | 非必须 | 所属模板标识 | ||
| ├─ c_regtype | string | 非必须 | 所有者性质 | ||
| ├─ c_status | number | 非必须 | 初审状态;详见附录 | ||
| ├─ failinfo | string | 非必须 | 初审失败原因 | ||
| ├─ regdate | string | 非必须 | 域名注册时间 | ||
| ├─ rexpiredate | string | 非必须 | 域名到期时间 | ||
| ├─ dns_host1 | string | 非必须 | dns1 | ||
| ├─ dns_host2 | string | 非必须 | dns2 | ||
| ├─ admi_pc | number | 非必须 | 管理联系人邮编 | ||
| ├─ admi_fax | string | 非必须 | 管理联系人传真 | ||
| ├─ admi_co | string | 非必须 | 管理联系人国家区码代码,详见附录 | ||
| ├─ admi_ct | string | 非必须 | 管理联系人城市(英文) | ||
| ├─ admi_em | string | 非必须 | 管理联系人邮箱 | ||
| ├─ admi_st | string | 非必须 | 管理联系人省份(英文) | ||
| ├─ admi_fn | string | 非必须 | 管理联系人名(英文) | ||
| ├─ admi_ph | string | 非必须 | 管理联系人电话 | ||
| ├─ admi_ln | string | 非必须 | 管理联系人姓(英文) | ||
| ├─ admi_adr | string | 非必须 | 管理联系人地址(英文) | ||
| ├─ dom_ln | string | 非必须 | 所有者名称(英文) | ||
| ├─ dom_fn | string | 非必须 | 所有者名(英文) | ||
| ├─ dom_fax | string | 非必须 | 所有者姓(英文) | ||
| ├─ dom_co | string | 非必须 | 所有者国家区域代码 | ||
| ├─ dom_ph | string | 非必须 | 所有者电话 | ||
| ├─ dom_org | string | 非必须 | 所有者所有者(英文) | ||
| ├─ dom_st | string | 非必须 | 所有者省份(英文) | ||
| ├─ dom_pc | string | 非必须 | 所有者邮编 | ||
| ├─ dom_ct | string | 非必须 | 所有者城市(英文) | ||
| ├─ dom_adr | string | 非必须 | 所有者地址(英文) | ||
| ├─ dom_em | string | 非必须 | 所有者邮箱 | ||
| ├─ bill_ct | string | 非必须 | 缴费联系人 | ||
| ├─ bill_em | string | 非必须 | 缴费联系人 | ||
| ├─ bill_ln | string | 非必须 | 缴费联系人 | ||
| ├─ bill_fax | string | 非必须 | 缴费联系人 | ||
| ├─ bill_st | string | 非必须 | 缴费联系人 | ||
| ├─ bill_ph | string | 非必须 | 缴费联系人 | ||
| ├─ bill_fn | string | 非必须 | 缴费联系人 | ||
| ├─ bill_adr | string | 非必须 | 缴费联系人 | ||
| ├─ bill_co | string | 非必须 | 缴费联系人 | ||
| ├─ bill_pc | number | 非必须 | 缴费联系人 | ||
| ├─ tech_fn | string | 非必须 | 技术联系人 | ||
| ├─ tech_ph | string | 非必须 | 技术联系人 | ||
| ├─ tech_st | string | 非必须 | 技术联系人 | ||
| ├─ tech_fax | string | 非必须 | 技术联系人 | ||
| ├─ tech_pc | number | 非必须 | 技术联系人 | ||
| ├─ tech_co | string | 非必须 | 技术联系人 | ||
| ├─ tech_ct | string | 非必须 | 技术联系人 | ||
| ├─ tech_em | string | 非必须 | 技术联系人 | ||
| ├─ tech_ln | string | 非必须 | 技术联系人 | ||
| ├─ tech_adr | string | 非必须 | 技术联系人 | ||
| ├─ dom_ln_m | string | 非必须 | 所有者 | ||
| ├─ tech_fn_m | string | 非必须 | 技术联系人 | ||
| ├─ bill_ct_m | string | 非必须 | 缴费联系人 | ||
| ├─ dom_fn_m | string | 非必须 | 所有者 | ||
| ├─ bill_ln_m | string | 非必须 | 缴费联系人 | ||
| ├─ admi_fn_m | string | 非必须 | 管理联系人 | ||
| ├─ tech_st_m | string | 非必须 | 技术联系人 | ||
| ├─ admi_ct_m | string | 非必须 | 管理联系人 | ||
| ├─ dom_org_m | string | 非必须 | 所有者 | ||
| ├─ admi_st_m | string | 非必须 | 管理联系人 | ||
| ├─ dom_st_m | string | 非必须 | 所有者 | ||
| ├─ dom_ct_m | string | 非必须 | 所有者 | ||
| ├─ dom_adr_m | string | 非必须 | 所有者 | ||
| ├─ admi_ln_m | string | 非必须 | 管理联系人 | ||
| ├─ admi_adr_m | string | 非必须 | 管理联系人 | ||
| ├─ tech_ct_m | string | 非必须 | 技术联系人 | ||
| ├─ bill_st_m | string | 非必须 | 缴费联系人 | ||
| ├─ tech_ln_m | string | 非必须 | 技术联系人 | ||
| ├─ tech_adr_m | string | 非必须 | 技术联系人 | ||
| ├─ bill_fn_m | string | 非必须 | 缴费联系人 | ||
| ├─ bill_adr_m | string | 非必须 | 缴费联系人 | ||
| ├─ r_status | number | 非必须 | 实名状态,详见附录 | ||
| ├─ r_failinfo | string | 非必须 | 实名拒绝原因 | ||
| ├─ orgfile | object | 非必须 | 实名资料数据 | ||
| ├─ f_sysid | number | 非必须 | 证件标识 | ||
| ├─ f_type | number | 非必须 | 证件类型,详件附录 | ||
| ├─ f_code | string | 非必须 | 证件号码 | ||
| ├─ f_date | string | 非必须 | 证件处理时间 |
4.9、获取实名token
基本信息
请求地址： /audit/?act=uploadwcftoken
请求方式： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| c_sysid | number | 是 | 123 | 模板标识 |
| f_type_org | number | 是 | 1 | 证件类型,详件附录 |
| f_code_org | string | 是 | 1234567823 | 证件号码 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | string | 必须 | token值 | ||
| msg | string | 非必须 | 出错信息 | ||
| errcode | number | 非必须 | 错误码 |
4.10、上传域名实名资料
基本信息
请求地址： https://netservice.vhostgo.com/wcfservice/Service1.svc/Wcf_AuditUploadFile
请求方式： POST
接口描述：
接口地址:https://netservice.vhostgo.com/wcfservice/Service1.svc/Wcf_AuditUploadFile
请先从"4.9 获取实名token"接口获取token后在调用本接口。
返回值:{"d":{"__type":"Wcf_result:#wcfservice","Data":[],"Msg":"….","Result":200}}
只取msg和result节点数据
result: 200 成功;500 失败
msg:失败:错误信息 成功:模板数据字符串
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body(json格式提交eg:{"token":"xxx","file_org":"图片base64转码"})
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| token | string | 必须 | 实名token，从4.9节获取 | ||
| file_org | string | 必须 | 图片完整的base64 |
4.11、域名模板过户
基本信息
请求地址： /audit/?act=auditghsub
请求方式： POST
接口描述：
超过一个域名过户时,只返回第一个域名过户信息,其它域名可通过查询过户状态信息查看
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | xxx.com | 域名,多个用英文逗号分隔 |
| eppidtype | string | 是 | dom_id,admin_id,tech_id,bill_id | 选择修改对象;dom_id:所有者;admin_id:管理联系人;tech_id:技术联系人;bill_id:缴费联系人;同时修改多个用逗号分隔 |
| c_sysid | number | 是 | 123 | 目标模板标识 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | object | 必须 | 返回数据 | ||
| ├─ xxxx.com | object | 必须 | |||
| ├─ dom_id | object | 必须 | |||
| ├─ result | number | 必须 | 状态 | ||
| ├─ msg | string | 必须 | 错误信息 | ||
| ├─ admin_id | object | 必须 | |||
| ├─ result | number | 必须 | |||
| ├─ msg | string | 必须 | |||
| msg | string | 必须 | 出错信息 | ||
| errcode | number | 必须 | 错误码 |
4.12、查询域名过户状态
基本信息
请求地址： /audit/?act=ghlist
请求方式： POST
接口描述：
其中retinfo.dom_id/admin_id/tech_id/bill_id如果前面三位字符串是200,则表示过户成功
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 否 | test.com | 域名 |
| c_sysid | number | 否 | 123 | 模板id |
| g_status | number | 否 | 过户状态;详情符录 | |
| g_date_begin | string | 否 | 过户操作添加时间段 yyyy-MM-dd HH:mm:ss | |
| g_date_end | string | 否 | 过户操作添加时间段 yyyy-MM-dd HH:mm:ss | |
| pageno | number | 否 | 1 | 页码 |
| pagesize | number | 否 | 20 | 每页条数 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 状态 | ||
| clientid | string | 必须 | 流水号 | ||
| data | object | 非必须 | 返回数据 | ||
| ├─ info | object [] | 必须 | |||
| ├─ g_status | number | 必须 | 过户状态（详情见附录） | ||
| ├─ c_sysid | number | 必须 | 模板标识 | ||
| ├─ retinfo | object | 必须 | 过户返回值 | ||
| ├─ dom_id | string | 非必须 | 所有者过户返回值 | ||
| ├─ admin_id | string | 非必须 | 管理联系人过户返回值 | ||
| ├─ tech_id | string | 非必须 | 技术联系人过户返回值 | ||
| ├─ bill_id | string | 非必须 | 财务联系人过户返回值 | ||
| ├─ g_date | string | 必须 | 过户任务添加时间 | ||
| ├─ g_enddate | string | 必须 | 过户任务结束时间 | ||
| ├─ strdomain | string | 必须 | 域名 | ||
| ├─ pagelist | object | 必须 | |||
| ├─ pagecount | number | 必须 | 总页数 | ||
| ├─ linecount | number | 必须 | 总记录数 | ||
| ├─ pageno | number | 必须 | 当前页码 | ||
| ├─ pagesize | number | 必须 | 每页记录数 | ||
| msg | string | 非必须 | 错误信息 | ||
| errcode | number | 非必须 | 错误码 |
五、域名转入
5.1、 提交域名转入
基本信息
请求地址： /transfer/?act=addnew
请求方式： POST
接口描述：
域名转入-将其他注册商的域名转入我司。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名。 |
| authcode | string | 是 | abc1234 | 域名转入密码。 |
| templateid | number | 否 | 100 | 模板数字ID，若不设置将使用默认模板。（请正确设置，以便可以自动过户以及com域名转入前实名） |
| setdns | number | 否 | 0 | 转入完成后是否修改DNS， 0=保持,1=设为我司 ，默认保持原DNS。 |
| hkfreename | string | 否 | 域名.hk | 仅限转入hk域名才需要填写 。 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 200=提交成功,500=提交失败 | ||
| clientid | string | 必须 | 请求识别码 | ||
| errcode | number | 非必须 | 发生错误时的错误编号 | ||
| msg | string | 非必须 | 发生错误时的错误详情 |
5.2、转移验证
基本信息
请求地址： /transfer/?act=check
请求方式： POST
接口描述：
检查一个域名是否可转入，返回转移价格
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名。 |
| authcode | string | 是 | abc1234 | 转移密码 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 200=检测通过,500=检测失败 | ||
| clientid | string | 必须 | |||
| errcode | number | 非必须 | |||
| msg | string | 非必须 | |||
| data | object | 非必须 | 检测通过时才有 | ||
| ├─ domain | string | 非必须 | 域名 | ||
| ├─ needprice | number | 非必须 | 价格 |
5.3、 获取列表
基本信息
请求地址： /transfer/?act=search
请求方式： POST
接口描述：
获取我的所有转移数据。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 否 | ||
| status | string | 否 | all | 状态取值范围 success=只显示成功,fail=只显示失败,pending=只显示正在转移的,all=无限 |
| startime | string | 否 | 2019-4-1 | 开始时间 |
| overtime | string | 否 | 2019-4-2 | 结束时间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | |||
| clientid | string | 必须 | |||
| data | object | 非必须 | 获取成功将返回分页信息 | ||
| ├─ pageno | number | 非必须 | 当前页码 | ||
| ├─ limit | number | 非必须 | 每页数量 | ||
| ├─ total | number | 非必须 | 总数据量 | ||
| ├─ pagecount | number | 非必须 | 总页码数 | ||
| ├─ items | object [] | 非必须 | |||
| ├─ sysid | string | 必须 | 转移id | ||
| ├─ domain | string | 必须 | 域名 | ||
| ├─ status | string | 必须 | 状态 | ||
| ├─ addtime | string | 必须 | 添加时间 | ||
| ├─ downtime | string,null | 必须 | 完成时间 | ||
| ├─ memo | string | 必须 | 备注 |
5.4、 撤消转入
基本信息
请求地址： /transfer/?act=cancel
请求方式： POST
接口描述：
中止域名转入。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名。 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 200=撤消成功,500=撤消失败 | ||
| clientid | string | 必须 | |||
| errcode | number | 非必须 | |||
| msg | string | 非必须 |
5.5、 刷新状态
基本信息
请求地址： /transfer/?act=refresh
请求方式： POST
接口描述：
用于手动刷新转入状态，以获取即时的转移进度。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | string | 是 | west.cn | 域名 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 必须 | 200=刷新成功,500=刷新失败 | ||
| clientid | string | 必须 | |||
| errcode | number | 非必须 | 200=转入成功,300=正在转入 | ||
| msg | string | 非必须 | 转入信息 |
六、附录
6.1、错误码说明(errcode)
| 错误码 | 详细错误 |
|---|---|
| 10000 | 认证失败 |
| 10001 | token 时间超时 |
| 10002 | ip 授权失败 |
| 10003 | 价格设置有误 |
| 20000 | 参数有误 |
| 20001 | 无权操作或数据不存在 |
| 20102 | 域名格式有误 |
| 20103 | 禁止注册 |
| 20104 | 域名密码长度必须大于8位 |
| 20105 | dns有误 |
| 20106 | 临时模板禁止操作 |
| 20107 | 修改DNS相同 |
| 20108 | 域名转移中不允许操作 |
| 20109 | 未注册DNS或不支持此类后缀的解析 |
| 20110 | 您域名所有者ID被CNNIC列入了黑名单 |
| 20111 | 域名状态不正确 |
| 20112 | DNS非我司不允许操作 |
| 20113 | 解析类型值有误 |
| 20114 | 禁止解析操作 |
| 20115 | 解析记录数超限制 |
| 20116 | 未添加默认线路 |
| 20118 | 记录已经存在重复添加 |
| 20119 | TTL值有误限制60-86400 |
| 20120 | 解析记录ID有误 |
| 20121 | 域名到期时间有误请联系管理员 |
| 30000 | 系统参数错误 |
| 30100 | 账号余额不足 |
| 30201 | 查询数据结果为空 |
| 30202 | 当前域名后缀接口维护 |
| 30203 | 创建相关联系人失败 |
| 30204 | DNS未授权 |
| 30205 | 已注册域名 |
| 30206 | 证件类型与证件号不匹配 |
| 30207 | 域名包括禁用词 |
| 30208 | 域名为保留或溢价域名 |
| 30209 | 年限只能为1,2,3,5年,不能为4年 |
| 30210 | 域名联系人地址长度超过64字符 |
| 30211 | 所有者ID在黑名单,请重新创建模板 |
| 30212 | 抱歉，续费失败，请联系管理员进行转入续费。 |
| 30213 | HK域名注册后24小时内不能续费 |
| 30214 | 域名已经进入赎回期,不能续费 |
| 30215 | 域名年限有误 |
| 30216 | 接口异常 |
| 域名转入:错误码 | 对应原因 |
|---|---|
| 24000 | 参数值无效 |
| 24001 | 此类域名不支持本操作 |
| 24002 | 此类域名不支持转入 |
| 24003 | 未能获取产品价格 |
| 24004 | 不能重复提交 |
| 24005 | 余额不足 |
| 24006 | 在检测域名Epp时失败 ，详见msg |
| 24007 | 验证模板失败 |
| 24008 | 在发送命令时失败 |
| 24009 | 入库时失败 |
| 24010 | 无权操作该记录 |
| 24011 | 在取消转入时失败 |
| 24012 | 在刷新转移时失败 |
| 域名转出:错误码 | 对应原因 |
|---|---|
| 25000 | 参数值无效 |
| 25001 | 此类域名不支持本操作 |
| 25002 | 过期域名不能转出 |
| 25003 | 因本地安全原因不可转出，详见msg |
| 25004 | 记录存在不可重复提交 |
| 25005 | 因上级安全原因不可转出，详见msg |
| 25006 | 无法获取密码 |
| 25007 | 入库时失败 |
| 25008 | 系统错误 |
| 25010 | 无权操作该记录 |
| 25011 | 不可重复操作 |
| 25012 | 在操作确认时失败 |
| 25013 | 在操作拒绝时失败 |
| 一口价购买:错误码 | 对应原因 |
|---|---|
| 29000 | 缺少参数或参数无效 |
| 29001 | 此一口价不存在或已经下架 |
| 29002 | 出价失败了 |
| 29003 | 价格已变动请重新出价 |
| 29004 | 余额不足 |
6.2、证件类型说明
| 证件编号 | 证件说明 | 个人(I)/企业(E) |
|---|---|---|
| 1 | 身份证 | I |
| 5 | 护照 | I |
| 6 | 港澳居民来往内地通行证 | I |
| 11 | 台湾居民来往大陆通行证 | I |
| 12 | 外国人永久居留身份证 | I |
| 30 | 港澳居民居住证 | I |
| 31 | 台湾居民居住证 | I |
| 2 | 组织机构代码证 | E |
| 3 | 工商营业执照 | E |
| 4 | 统一社会信用代码证书 | E |
| 7 | 部队代号 | E |
| 8 | 军队单位对外有偿服务许可证 | E |
| 9 | 事业单位法人证书 | E |
| 10 | 外国企业常驻代表机构登记证 | E |
| 13 | 社会团体法人登记证书 | E |
| 14 | 宗教活动场所登记证 | E |
| 15 | 民办非企业单位登记证书 | E |
| 16 | 基金会法人登记证书 | E |
| 17 | 律师事务所执行许可证 | E |
| 18 | 外国在华文化中心登记证 | E |
| 19 | 外国政府旅游部门常驻代表机构批准登记证 | E |
| 20 | 司法鉴定许可证 | E |
| 21 | 社会服务机构登记证书 | E |
| 22 | 民办学校办学许可证 | E |
| 23 | 医疗机构执行许可证 | E |
| 24 | 境外机构证件 | E |
| 28 | 公证机构执业证 | E |
| 29 | 北京市外国驻华使馆人员子女学校办学许可证 | E |
| 30 | 港澳居民居住证 | I |
| 31 | 台湾居民居住证 | I |
| 32 | 含统一社会信用代码的其它证件(非营业执照、非组织机构代码证) | E |
6.3、域名状态说明
| 初审状态码 | 初审状态说明 |
|---|---|
| 0 | 未传图片 |
| 1 | 初审通过 |
| 2 | 初审中 |
| 3 | 初审拒绝 |
| 4 | 初审异常 |
| 实名状态码 | 实名状态名称 |
|---|---|
| 0 | 未实名 |
| 1 | 实名成功 |
| 2 | 实名审核中 |
| 3 | 实名拒绝 |
| 4 | 实名异常 |
| 5 | 等待上报 |
| 过户状态码 | 过户状态名称 |
|---|---|
| 0 | 等待过户 |
| 1 | 过户成功 |
| 2 | 过户中 |
| 3 | 过户失败 |
| 4 | 过户异常 |
| 命名审核状态码 | 命名审核名称 |
|---|---|
| 1 | 命名审核中 |
| 2 | 命名成功 |
| 3 | 命名失败 |
请求参数
6.4、国家及地区电话编码
| 国家或区域 | 英文简称 | 电话代码 |
|---|---|---|
| 中国 | CN | +86 |
| 阿尔巴尼亚 | AL | +355 |
| 阿尔及利亚 | DZ | +213 |
| 阿富汗 | AF | +93 |
| 阿根廷 | AR | +54 |
| 阿拉伯联合大公国 | AE | +971 |
| 阿鲁巴 | AW | +297 |
| 阿曼 | OM | +968 |
| 阿塞拜疆 | AZ | +994 |
| 埃及 | EG | +20 |
| 埃塞俄比亚 | ET | +251 |
| 爱尔兰 | IE | +353 |
| 爱沙尼亚 | EE | +372 |
| 安道尔 | AD | +376 |
| 安哥拉 | AO | +244 |
| 安圭拉 | AI | +1264 |
| 安提瓜和巴布达 | AG | +1268 |
| 奥地利 | AT | +43 |
| 澳大利亚 | AU | +61 |
| 中国澳门 | MO | +853 |
| 巴巴多斯 | BB | +1246 |
| 巴布亚新几内亚 | PG | +675 |
| 巴哈马 | BS | +1242 |
| 巴基斯坦 | PK | +92 |
| 巴拉圭 | PY | +595 |
| 巴勒斯坦领土 | PS | +970 |
| 巴林 | BH | +973 |
| 巴拿马 | PA | +507 |
| 巴西 | BR | +55 |
| 白俄罗斯 | BY | +375 |
| 百慕大 | BM | +1441 |
| 保加利亚 | BG | +359 |
| 贝宁 | BJ | +229 |
| 比利时 | BE | +32 |
| 冰岛 | IS | +354 |
| 波多黎各 | PR | +1787 |
| 波兰 | PL | +48 |
| 波斯尼亚和黑塞哥维那 | BA | +387 |
| 玻利维亚 | BO | +591 |
| 伯利兹 | BZ | +501 |
| 博茨瓦纳 | BW | +267 |
| 不丹 | BT | +975 |
| 布基纳法索 | BF | +226 |
| 布隆迪 | BI | +257 |
| 朝鲜 | KP | +850 |
| 赤道几内亚 | GQ | +240 |
| 丹麦 | DK | +45 |
| 德国 | DE | +49 |
| 东帝汶 | TL | +670 |
| 多哥 | TG | +228 |
| 多米尼加 | DM | +1767 |
| 多明尼加共和国 | DO | +1809 |
| 俄罗斯 | RU | +7 |
| 厄瓜多尔 | EC | +593 |
| 厄立特里亚 | ER | +291 |
| 法国 | FR | +33 |
| 法罗群岛 | FO | +298 |
| 法属波利尼西亚 | PF | +689 |
| 法属圭亚那 | GF | +594 |
| 菲律宾 | PH | +63 |
| 斐济 | FJ | +679 |
| 芬兰 | FI | +358 |
| 佛得角 | CV | +238 |
| 冈比亚 | GM | +220 |
| 刚果共和国 | CG | +242 |
| 刚果民主共和国 | CD | +243 |
| 哥伦比亚 | CO | +57 |
| 哥斯达黎加 | CR | +506 |
| 格林纳达 | GD | +1473 |
| 格陵兰 | GL | +299 |
| 格鲁吉亚 | GE | +995 |
| 古巴 | CU | +53 |
| 瓜德罗普岛 | GP | +590 |
| 关岛 | GU | +1671 |
| 圭亚那 | GY | +592 |
| 哈萨克斯坦 | KZ | +7 |
| 海地 | HT | +509 |
| 韩国 | KR | +82 |
| 荷兰 | NL | +31 |
| 荷属安的列斯群岛 | AN | +599 |
| 黑山 | ME | +382 |
| 洪都拉斯 | HN | +504 |
| 吉布提 | DJ | +253 |
| 吉尔吉斯斯坦 | KG | +996 |
| 几内亚 | GN | +224 |
| 几内亚比绍 | GW | +245 |
| 加拿大 | CA | +1 |
| 加纳 | GH | +233 |
| 加蓬 | GA | +241 |
| 柬埔寨 | KH | +855 |
| 捷克共和国 | CZ | +420 |
| 津巴布韦 | ZW | +263 |
| 喀麦隆 | CM | +237 |
| 卡塔尔 | QA | +974 |
| 开曼群岛 | KY | +1345 |
| 科摩罗 | KM | +269 |
| 科威特 | KW | +965 |
| 克罗地亚 | HR | +385 |
| 肯尼亚 | KE | +254 |
| 库克群岛 | CK | +682 |
| 拉脱维亚 | LV | +371 |
| 莱索托 | LS | +266 |
| 老挝 | LA | +856 |
| 黎巴嫩 | LB | +961 |
| 立陶宛 | LT | +370 |
| 利比里亚 | LR | +231 |
| 利比亚 | LY | +218 |
| 列支敦士登 | LI | +423 |
| 留尼旺岛 | RE | +262 |
| 卢森堡 | LU | +352 |
| 卢旺达 | RW | +250 |
| 罗马尼亚 | RO | +40 |
| 马达加斯加 | MG | +261 |
| 马尔代夫 | MV | +960 |
| 马耳他 | MT | +356 |
| 马拉维 | MW | +265 |
| 马来西亚 | MY | +60 |
| 马里 | ML | +223 |
| 马其顿 | MK | +389 |
| 马提尼克 | MQ | +596 |
| 毛里求斯 | MU | +230 |
| 毛里塔尼亚 | MR | +222 |
| 美国 | US | +1 |
| 蒙古 | MN | +976 |
| 蒙特塞拉特 | MS | +1664 |
| 孟加拉国 | BD | +880 |
| 秘鲁 | PE | +51 |
| 摩尔多瓦 | MD | +373 |
| 摩洛哥 | MA | +212 |
| 摩纳哥 | MC | +377 |
| 莫桑比克 | MZ | +258 |
| 墨西哥 | MX | +52 |
| 纳米比亚 | NA | +264 |
| 南非 | ZA | +27 |
| 南苏丹 | SS | +211 |
| 尼泊尔 | NP | +977 |
| 尼加拉瓜 | NI | +505 |
| 尼日尔 | NE | +227 |
| 尼日利亚 | NG | +234 |
| 挪威 | NO | +47 |
| 葡萄牙 | PT | +351 |
| 日本 | JP | +81 |
| 瑞典 | SE | +46 |
| 瑞士 | CH | +41 |
| 萨尔瓦多 | SV | +503 |
| 萨摩亚 | WS | +685 |
| 塞尔维亚 | RS | +381 |
| 塞拉利昂 | SL | +232 |
| 塞内加尔 | SN | +221 |
| 塞浦路斯 | CY | +357 |
| 塞舌尔 | SC | +248 |
| 沙特阿拉伯 | SA | +966 |
| 圣多美和普林西比 | ST | +239 |
| 圣基茨和尼维斯 | KN | +1869 |
| 圣卢西亚 | LC | +1758 |
| 圣马力诺 | SM | +378 |
| 圣皮埃尔和密克隆群岛 | PM | +508 |
| 圣文森特和格林纳丁斯 | VC | +1784 |
| 斯里兰卡 | LK | +94 |
| 斯洛伐克 | SK | +421 |
| 斯洛文尼亚 | SI | +386 |
| 斯威士兰 | SZ | +268 |
| 苏丹 | SD | +249 |
| 苏里南 | SR | +597 |
| 索马里 | SO | +252 |
| 塔吉克斯坦 | TJ | +992 |
| 中国台湾 | TW | +886 |
| 泰国 | TH | +66 |
| 坦桑尼亚 | TZ | +255 |
| 汤加 | TO | +676 |
| 特克斯和凯科斯群岛> | TC | +1649 |
| 特里尼达和多巴哥 | TT | +1868 |
| 突尼斯 | TN | +216 |
| 土耳其 | TR | +90 |
| 土库曼斯坦 | TM | +993 |
| 瓦努阿图 | VU | +678 |
| 危地马拉 | GT | +502 |
| 委内瑞拉 | VE | +58 |
| 文莱 | BN | +673 |
| 乌干达 | UG | +256 |
| 乌克兰 | UA | +380 |
| 乌拉圭 | UY | +598 |
| 乌兹别克斯坦 | UZ | +998 |
| 西班牙 | ES | +34 |
| 希腊 | GR | +30 |
| 中国香港 | HK | +852 |
| 象牙海岸 | CI | +225 |
| 新加坡 | SG | +65 |
| 新喀里多尼亚 | NC | +687 |
| 新西兰 | NZ | +64 |
| 匈牙利 | HU | +36 |
| 叙利亚 | SY | +963 |
| 牙买加 | JM | +1876 |
| 亚美尼亚 | AM | +374 |
| 也门 | YE | +967 |
| 伊拉克 | IQ | +964 |
| 伊朗 | IR | +98 |
| 以色列 | IL | +972 |
| 意大利 | IT | +39 |
| 印度 | IN | +91 |
| 印尼 | ID | +62 |
| 英国 | GB | +44 |
| 英属维尔京群岛 | VG | +1340 |
| 约旦 | JO | +962 |
| 越南 | VN | +84 |
| 赞比亚 | ZM | +260 |
| 泽西岛 | JE | +44 |
| 乍得 | TD | +235 |
| 直布罗陀 | GI | +350 |
| 智利 | CL | +56 |
| 中非共和国 | CF | +236 |
七、域名一口价购买
全量列表下载
基本信息
Path： /oneprice/?act=getall
Method： GET
接口描述：
获取当前正在出售中的所有一口价列表，此数据每天凌晨5点更新（全量数据通常首次调用，以后不必再调用）
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | 成功=200，失败=500 | ||
| clientid | string | 非必须 | |||
| errcode | number | 非必须 | |||
| msg | string | 非必须 | 成功时返回下载url地址 |
昨日下架域名
基本信息
Path： /oneprice/?act=getdrop
Method： GET
接口描述：
获取昨日已经结束/下架的一口价域名列表，此数据每天凌晨5点更新（此功能可每天都调用一次，以删除本地无用数据）
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | 成功=200，失败=500 | ||
| clientid | string | 非必须 | |||
| errcode | number | 非必须 | |||
| msg | string | 非必须 | 成功时返回下载url地址 |
昨日新增域名
基本信息
Path： /oneprice/?act=getnew
Method： GET
接口描述：
获取昨日新发布的一口价域名列表，此数据每天凌晨5点更新（此功能可每天都调用一次，以保持本地更新）
请求参数
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | 成功=200，失败=500 | ||
| clientid | string | 非必须 | |||
| errcode | number | 非必须 | |||
| msg | string | 非必须 | 成功时返回下载url地址 |
获取单个域名详情
基本信息
Path： /oneprice/?act=check
Method： POST
接口描述：
获取一个正在出售中的域名信息，如果成功返回详情，如果已经下架或结束，则返回失败。
此接口有频率限制1分钟300次。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | text | 是 | test.com | 需要查询信息的域名 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | 成功=200，失败=500 | ||
| clientid | string | 非必须 | |||
| errcode | number | 非必须 | |||
| msg | string | 非必须 | 错误原因 | ||
| data | object | 非必须 | |||
| ├─ p_id | number | 非必须 | 交易ID | ||
| ├─ domain | string | 非必须 | 域名 | ||
| ├─ price | number | 非必须 | 售价 | ||
| ├─ expire | string | 非必须 | 域名过期时间 | ||
| ├─ title | string | 非必须 | 卖家备注 | ||
| ├─ overtime | string | 非必须 | 交易结束时间 |
购买单个一口价域名
基本信息
Path： /oneprice/?act=buy
Method： POST
接口描述：
购买一口价域名，需要传入原价，如果与现出售价格不一致则会失败，当购买成功后将过户到您的默认模板。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| domain | text | 是 | test.com | 购买的域名 |
| price | text | 是 | 80 | 域名校验价格 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| result | number | 非必须 | 购买成功=200，购买失败=500 | ||
| clientid | string | 非必须 | |||
| errcode | number | 非必须 | |||
| msg | string | 非必须 | 失败原因 |
相关文章
发表评论
