接口文档

cqchain.net

2385字约8分钟

2024-08-19

1 发行方注册接口

1.1 接口信息

接口名(method)	cqchain.issuer.register
版本号(version)	1.0

请求方法

POST

1.2 请求参数

公共请求参数

名称	类型	必须	描述	示例值
app_id	string	是	接入方 appId	20200317689494536224768000
method	string	是	接口名	user.userinfo.get
version	string	是	版本号	1.0
charset	string	是	字符编码	UTF-8
timestamp	string	是	时间戳，格式为 yyyy-MM-dd HH:mm:ss，时区为 GMT+8。服务端允许客户端请求最大时间误差为 10 分钟	2020-11-01 13:44:11
app_auth_token	string	否	token	01c9a4191bfd4609d26
sign	string	是	请求参数的签名串，签名算法介绍	xxxx

业务请求参数

名称	类型	必须	最大长度	描述	示例值
X-Access-Token	string	否	-	token
busiLicenseFilePath	string	否	-	营业执照文件路径，发行方类型为企业时，该字段必填	XXX
businessType	integer	否	-	平台业务类型(1:金融类 2:版权类 3:其他类 4:未填写)，默认是未填写
cardType	integer	是	-	证件类型 1-身份证 2-护照 3-港澳通行证 4-台湾通行证 5-外国人永居身份证 6-港澳台居民居住证 7-其他	XXX
contact	string	是	-	管理员姓名	XXX
creditCode	string	否	-	企业信用代码，发行方类型为企业时，该字段必填	XXX
description	string	否	-	发行方描述	XXX
email	string	否	-	邮箱	XXX
epName	string	是	-	发行方名称	XXX
idcard	string	是	-	管理员证件号码	XXX
logo	string	否	-	发行方 logo，发行方类型为企业时，该字段必填	XXX
mobile	string	是	-	管理员手机号	XXX
officialLetterFilePath	string	否	-	电子公函盖章扫描件文件路径	XXX
operateId	string	是	-	请求 ID，每个请求需要填唯一的 id，重复请求用相同的 id	防止重复发生，请采用 UUID
platformName	string	否	-	接入平台名称	XXX
platformUrl	string	否	-	接入平台地址	XXX
representativeName	string	否	-	法人代表姓名，发行方类型为企业时，该字段必填	XXX
type	integer	是	-	发行方类型，1:个人 2:企业	1

1.3 响应参数

公共响应参数

名称	类型	描述	示例值
request_id	string	每次请求唯一 id	4e770f101c9a4191bfd4609d26c6e0bd
code	string	返回码	40002
msg	string	返回信息	非法的参数
sub_code	string	请求失败返回的子错误码	isv.invalid-app-key
sub_msg	string	请求失败返回的子错误信息	无效的 app_id 参数

业务响应参数

名称	类型	必须	最大长度	描述	示例值
code	integer	否	-	响应编码:0 正常，非 0 异常	0
data	string	否	-	发行方注册返回数据
msg	string	否	-	响应消息描述

响应示例

{
  "cqchain_issuer_register_response": {
    "request_id": "4b8e7ca9cbcb448491df2f0120e49b9d",
    "code": "0",
    "msg": "",
    "data": "{\"issuerAddress\":\"0x0df47d2d7a3970d899cd5e8fca2c6fe181d69308\"}"
  }
}

错误示例

{
  "error_response": {
    "request_id": "0d27836fcac345729176359388aeeb74",
    "code": "40004",
    "msg": "业务处理失败",
    "sub_code": "isv.name-error",
    "sub_msg": "姓名错误"
  }
}

2 数字藏品系列声明

2.1 接口信息

接口名(method)	cqchain.nft.series.claim
版本号(version)	1.0

请求方法

POST

2.2 请求参数

公共请求参数

名称	类型	必须	描述	示例值
app_id	string	是	接入方 appId	20200317689494536224768000
method	string	是	接口名	user.userinfo.get
version	string	是	版本号	1.0
charset	string	是	字符编码	UTF-8
timestamp	string	是	时间戳，格式为 yyyy-MM-dd HH:mm:ss，时区为 GMT+8。服务端允许客户端请求最大时间误差为 10 分钟	2020-11-01 13:44:11
app_auth_token	string	否	token	01c9a4191bfd4609d26
sign	string	是	请求参数的签名串，签名算法介绍	xxxx

业务请求参数

名称	类型	必须	最大长度	描述	示例值
X-Access-Token	string	否	-	token
coverUrl	string	是	-	系列封面 url，不超过 1024 个字符	https://xxx
desc	string	是	-	系列描述信息，不超过 500 个字符	XXX 系列
isSame	boolean	是	-	系列发行是否同质化，同质化发行:true,非同质化发行:false	true
issuerAddress	string	是	-	发行方地址	0x8a5f6e85dd884eede6f9de1bbfc1d9d5951f00fe
operateId	string	是	-	请求 ID，每个请求需要填唯一的 id，重复请求用相同的 id	防止重复发生，请采用 UUID
price	integer	是	-	系列发行价格，不得超过 99999999	1000
sellStatus	integer	是	-	售卖状态 1:可售 2:不可售
seriesName	string	是	-	系列名，不超过 30 个字符	十二生肖无极鼠
totalCount	integer	是	-	系列下数字藏品总个数，不得超过 50000	1000
url	string	是	-	系列 url，不超过 1024 个字符	https://xxx
urlHash	string	否	-	urlHash

2.3 响应参数

公共响应参数

名称	类型	描述	示例值
request_id	string	每次请求唯一 id	4e770f101c9a4191bfd4609d26c6e0bd
code	string	返回码	40002
msg	string	返回信息	非法的参数
sub_code	string	请求失败返回的子错误码	isv.invalid-app-key
sub_msg	string	请求失败返回的子错误信息	无效的 app_id 参数

业务响应参数

名称	类型	必须	最大长度	描述	示例值
code	integer	否	-	响应编码:0 正常，非 0 异常	0
**data		否	-	声明数字藏品系列返回数据	声明数字藏品系列返回数据
seriesAddress	string	否	-	系列地址	系列地址
msg	string	否	-	响应消息描述

响应示例

{
  "cqchain_nft_series_claim_response": {
    "request_id": "4b8e7ca9cbcb448491df2f0120e49b9d",
    "code": "0",
    "msg": "",
    "data": {
      "seriesAddress": "系列地址"
    }
  }
}

错误示例

{
  "error_response": {
    "request_id": "0d27836fcac345729176359388aeeb74",
    "code": "40004",
    "msg": "业务处理失败",
    "sub_code": "isv.name-error",
    "sub_msg": "姓名错误"
  }
}

3 发行数字藏品

3.1 接口信息

接口名(method)	cqchain.nft.publish
版本号(version)	1.0

请求方法

POST

3.2 请求参数

公共请求参数

名称	类型	必须	描述	示例值
app_id	string	是	接入方 appId	20200317689494536224768000
method	string	是	接口名	user.userinfo.get
version	string	是	版本号	1.0
charset	string	是	字符编码	UTF-8
timestamp	string	是	时间戳，格式为 yyyy-MM-dd HH:mm:ss，时区为 GMT+8。服务端允许客户端请求最大时间误差为 10 分钟	2020-11-01 13:44:11
app_auth_token	string	否	token	01c9a4191bfd4609d26
sign	string	是	请求参数的签名串，签名算法介绍	xxxx

业务请求参数

名称	类型	必须	最大长度	描述	示例值
X-Access-Token	string	否	-	token
author	string	是	-	作者名，中文+英文（数字或符号为非法输入）不超过 30 个字符。
desc	string	是	-	数字藏品简介，500 个字符以内。
displayUrl	string	是	-	预览图 url，不超过 1024 个字符。（至信链浏览器展示预览图尺寸为 290*290，请上传比例为 1:1 的图片）。	https://xxx
isSame	boolean	是	-	系列发行是否同质化，同质化发行:true,非同质化发行:false	true
name	string	是	-	数字藏品名字，中英文数字均可，不超过 256 个字符。
operateId	string	是	-	请求 ID，每个请求需要填唯一的 id，重复请求用相同的 id	防止重复发生，请采用 UUID
price	integer	是	-	发行价格，不得超过 99999999	1000
sellStatus	integer	是	-	售卖状态 1:可售 2:不可售
seriesAddress	string	否	-	系列地址，发行已声明过系列的数字藏品时，请填写系列地址。发行未声明过系列的数字藏品时，可不填。	0x8a5f6e85dd884eede6f9de1bbfc1d9d5951f00fe
seriesBeginIndex	integer	是	-	系列子 ID 从多少开始，没有系列只能填 1。总体上不超过系列的最大值，（比如系列如果从 1 开始，最大值为 100，系列子 ID 只能从 1-100）
url	string	是	-	介质 url，不超过 1024 个字符	https://xxx
urlHash	string	否	-	urlHash

3.3 响应参数

公共响应参数

名称	类型	描述	示例值
request_id	string	每次请求唯一 id	4e770f101c9a4191bfd4609d26c6e0bd
code	string	返回码	40002
msg	string	返回信息	非法的参数
sub_code	string	请求失败返回的子错误码	isv.invalid-app-key
sub_msg	string	请求失败返回的子错误信息	无效的 app_id 参数

业务响应参数

名称	类型	必须	最大长度	描述	示例值
code	integer	否	-	响应编码:0 正常，非 0 异常	0
data	object	否	-	发行数字藏品返回数据	发行数字藏品返回数据
msg	string	否	-	响应消息描述

响应示例

{
  "cqchain_nft_publish_response": {
    "request_id": "4b8e7ca9cbcb448491df2f0120e49b9d",
    "code": "0",
    "msg": "",
    "data": "发行数字藏品返回数据"
  }
}

错误示例

{
  "error_response": {
    "request_id": "0d27836fcac345729176359388aeeb74",
    "code": "40004",
    "msg": "业务处理失败",
    "sub_code": "isv.name-error",
    "sub_msg": "姓名错误"
  }
}

4 转移数字藏品

4.1 接口信息

接口名(method)	cqchain.nft.transfer
版本号(version)	1.0

请求方法

POST

4.2 请求参数

公共请求参数

名称	类型	必须	描述	示例值
app_id	string	是	接入方 appId	20200317689494536224768000
method	string	是	接口名	user.userinfo.get
version	string	是	版本号	1.0
charset	string	是	字符编码	UTF-8
timestamp	string	是	时间戳，格式为 yyyy-MM-dd HH:mm:ss，时区为 GMT+8。服务端允许客户端请求最大时间误差为 10 分钟	2020-11-01 13:44:11
app_auth_token	string	否	token	01c9a4191bfd4609d26
sign	string	是	请求参数的签名串，签名算法介绍	xxxx

业务请求参数

名称	类型	必须	最大长度	描述	示例值
X-Access-Token	string	否	-	token
fromAddress	string	是	-	数字藏品属主地址	0x8a5f6e85dd884eede6f9de1bbfc1d9d5951f00fe
seriesAddress	string	是	-	系列地址	0x8a5f6e85dd884eede6f9de1bbfc1d9d5951f00fe
seriesBeginIndex	integer	是	-	系列子 ID 从多少开始，没有系列只能填 1。
toAddress	string	是	-	数字藏品赠予地址	0x8a5f6e85dd884eede6f9de1bbfc1d9d5951f00fe

4.3 响应参数

公共响应参数

名称	类型	描述	示例值
request_id	string	每次请求唯一 id	4e770f101c9a4191bfd4609d26c6e0bd
code	string	返回码	40002
msg	string	返回信息	非法的参数
sub_code	string	请求失败返回的子错误码	isv.invalid-app-key
sub_msg	string	请求失败返回的子错误信息	无效的 app_id 参数

业务响应参数

响应示例

名称	类型	必须	最大长度	描述	示例值
code	integer	否	-	响应编码:0 正常，非 0 异常	0
data	string	否	-	转移数字藏品返回数据	{"blockNumber":100,"transactionHash":"0x0ccfa821408ef259fa8485eff03dd2c5237b5f232a4fcd1010086af93e3827a9","status":0}
msg	string	否	-	响应消息描述

{
  "cqchain_nft_transfer_response": {
    "request_id": "4b8e7ca9cbcb448491df2f0120e49b9d",
    "code": "0",
    "msg": "",
    "data": "{\"blockNumber\":100,\"transactionHash\":\"0x0ccfa821408ef259fa8485eff03dd2c5237b5f232a4fcd1010086af93e3827a9\",\"status\":0}"
  }
}

错误示例

{
  "error_response": {
    "request_id": "0d27836fcac345729176359388aeeb74",
    "code": "40004",
    "msg": "业务处理失败",
    "sub_code": "isv.name-error",
    "sub_msg": "姓名错误"
  }
}