Icon Created with Sketch.

西部数码业务API文档 V2.0

  • ← 返回目录
  • 认证相关
    • 1.1、文档简介
    • 1.2、身份验证
    • 1.3、公共参数说明
    • 1.4、统一返回说明
    • 1.5、联调环境说明
    • 1.6、技术支持
    • 1.7、 下载PHP示例代码
    • 1.8、获取账户可用余额
  • 中小企业数字化赋能行动(免费域名)
    • 中小企业数字化赋能行动说明
    • 1、获取域名模板列表
    • 2、创建域名模板
    • 3、上传域名模板资料
    • 4、修改域名模板资料
    • 5、删除域名模板
    • 6、获取域名模板审核状态
    • 7、获取域名列表
    • 8、注册域名
    • 9、查询域名状态
    • 10、上传域名模板资料图片Base64

中小企业数字化赋能行动(免费域名)

中小企业数字化赋能行动说明


特别说明调用本文档创建的域名模板,只适用于本次中小企业数字化赋能行动,不与其他接口兼容。

1. 本活动只限中小企业用户参加。
2. 参加活动的中小企业应符合国家统计局发布的《统计上大中小微型企业划分办法(2017)》中的大中小微型企业划分标准。最终以cnnic审核结果为准。
3. 活动期间每个中小企业只能参与1次,只能免费注册1个国家顶级域名(.CN或.中国),免费期1年,到期后可以市场价格续费。
4. 通过本活动成功注册的国家顶级域名,均可申请免费使用国家顶级域名隐私保护服务1年。
5. 成功注册国家顶级域名的中小企业可以优惠价格向联合开展活动的注册服务机构选择多种互联网应用服务和产品。
6. 因注册局未明确各个字段具体长度及格式,文档内相关提示仅供参考,具体以注册局判定为准


域名模板状态

值 说明
waiting 待提交审核
auditing 审核中
pass 审核通过
unpass 审核失败

域名状态

值 说明
auditing 审核中
pass 审核通过
unpass 审核失败

支持企业证件类型

值 说明
YYZZ 营业执照
ORG 组织机构代码
QT 其他

企业类型

值 说明
PU 工商
PR 个体

1、获取域名模板列表

基本信息

Path: /domain/cnfree/?act=list

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 否 法人
org text 否 企业名称
email text 否 邮箱
phone text 否 联系电话
status text 否 状态 状态
pageSize text 否 20 每页大小
page text 否 1 第几页

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须
clientidstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ namestring必须所有人
├─ orgstring必须企业名称
├─ phonestring必须电话
├─ created_atstring必须创建时间
├─ emailstring必须邮箱
├─ realname_statusstring必须认证状态
├─ spstring必须省份
├─ citystring必须城市
├─ streetstring必须街道
├─ cidstring必须模板id
├─ pagenumber非必须当前页
├─ pageSizenumber非必须每页显示
├─ totalCountnumber非必须总数

2、创建域名模板

基本信息

Path: /domain/cnfree/?act=create

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
name text 是 法人 法人姓名(限64字符)
org text 是 企业名称 企业名称(限255字符)
sp text 是 四川省 省份(限64字符)
city text 是 成都市 城市(限64字符)
street text 是 西门车站 街道(限64个字符)
email text 是 test@mail.com 邮箱(限80个字符)
phone text 是 139xxxxxxxxxx 电话(正则:([0-9]{1,3}.[0-9]{1,14}))
c_type text 是 YYZZ 企业证件类型
c_number text 是 5101111111111xx 企业证件号码
main_contact_id text 否 0 主站实名模板ID,不填写将在帐号下用当前资料创建

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须
clientidstring非必须
dataobject非必须
├─ cidstring非必须模板ID

3、上传域名模板资料

基本信息

Path: /domain/cnfree/?act=realnameupload

Method: POST

接口描述:

特别说明: 认证参数请用GET提交(username,time,token)
form-data提交

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data 是

Body

参数名称 参数类型 是否必须 示例 备注
cid text 是 模板ID
idCode text 是 身份证号
idImg file 是 身份证图片(限2M)
orgProofType text 是 YYZZ 企业证件类型 YYZZ-营业执照 ORG-组织机构代码 QT-其他
orgCode text 是 企业证件号码
orgType text 是 PU 企业类型 PU-工商 PR-个体
orgImg file 是 企业证件图片(限2M)
userRegion text 是 D D-国内
registrantType text 是 E E-企业

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ statusstring非必须状态
├─ reasonstring非必须说明

4、修改域名模板资料

基本信息

Path: /domain/cnfree/?act=update

Method: POST

接口描述:

仅支持(waiting-待提交审核和unpass-审核失败)

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cid text 是 模板ID
city text 否 所在城市(限64字符)
sp text 否 所在省(限64字符)
street text 否 所在街道(限64个字符)
email text 否 邮箱地址
phone text 否 联系电话(正则:([0-9]{1,3}.[0-9]{1,14}))

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须
clientidstring非必须
datastring非必须

5、删除域名模板

基本信息

Path: /domain/cnfree/?act=delete

Method: POST

接口描述:

仅能删除( waiting-待提交审核 unpass-审核失败 )状态

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cid text 是 模板ID

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须
clientidstring非必须
datastring非必须

6、获取域名模板审核状态

基本信息

Path: /domain/cnfree/?act=chkstatus

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cid text 是 模板ID

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须
clientidstring非必须
dataobject非必须
├─ statusstring非必须状态

7、获取域名列表

基本信息

Path: /domain/cnfree/?act=domainlist

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
pageSize text 否 每页数量
page text 否 第几页

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须
clientidstring非必须
dataobject非必须
├─ dataobject []非必须

item 类型: object

├─ idstring必须编号
├─ reg_datestring必须注册时间
├─ expire_datestring必须到期时间
├─ domainstring必须域名
├─ domain_extstring必须后缀
├─ statusstring必须审核状态
├─ reasonstring必须失败原因
├─ pagenumber非必须页数
├─ pageSizenumber非必须每页大小
├─ totalCountnumber非必须总数

8、注册域名

基本信息

Path: /domain/cnfree/?act=createdomain

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
contact_id text 是 模板ID
domain text 是 域名(.cn或.中国)
dns text 否 dns未填写使用我司,多dns用英文逗号分隔,最多6个

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须
clientidstring非必须
datastring非必须

9、查询域名状态

基本信息

Path: /domain/cnfree/?act=domainstatus

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
domain text 是 域名

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
dataobject非必须
├─ statusstring非必须状态
├─ reasonstring非必须说明

10、上传域名模板资料图片Base64

基本信息

Path: /domain/cnfree/?act=realnameuploadbase64

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
cid text 是 模板ID
idCode text 是 身份证号
idImg text 是 身份证图片(限2M)Base64图片(只要逗号后内容data:image/gif;base64,xxxxx)
orgProofType text 是 YYZZ 企业证件类型 YYZZ-营业执照 ORG-组织机构代码 QT-其他
orgCode text 是 企业证件号码
orgType text 是 PU 企业类型 PU-工商 PR-个体
orgImg text 是 企业证件图片(限2M)Base64图片(只要逗号后内容data:image/gif;base64,xxxxx)
userRegion text 是 D D-国内
registrantType text 是 E E-企业

返回数据

名称类型是否必须默认值备注其他信息
resultnumber非必须200为成功
clientidstring非必须
dataobject非必须

Build by west.