数字商品上链接口

1. 场景描述
数字藏品发行方通过数字藏品发行平台发行数字藏品。
数字藏品可以分为有系列数字藏品和无系列数字藏品两种。
有系列数字藏品,需要用户首先定义系列,并且在系列中规定该系列中数字藏品数量上限。
无系列场景即发布单一的数字藏品,只发一个数字藏品,使用无系列发行。
2. 场景交互图
注意:
1、系列名称全局唯一,不可与其他企业的系列名称相同。
2、如果是至信链,相同Hash在一个系列中,目前最大可发5000份。
流程:
1. 数字商品发行用户进行系列声明。
2. 数字商品发行用户使用系列id, 发行数字商品。
3. 数字商品平台查询发行任务结果,获取数字商品id。
3. 相关接口
1)数字商品 系列声明
说明:系列声明,企业内外均不可重复声明系列名称
接口:api/v1/series/create
请求方式:post
请求参数:
字段名称 类型 是否必填 描述
merchantId int64 商户id,由薄盒分配
seriesName string 系列名称
creatorName string 创作家名称
coverUrl string 系列封面url,不超过1024个字符
desc string 系列描述信息,不超过500个字符
signData int 签名:md5(seriesName_creatorName_coverUrl_desc_secretKey)
响应参数:
字段名 类型 是否必填 描述
code int

正确:200

错误:500

msg string

正确:成功

错误:错误原因

data string {"taskId":"任务编号"}
2)查询 数字商品 系列声明结果
说明:任务Id查询系列信息
接口:api/v1/user/query
例如:api/v1/user/query/9527
请求方式:get
请求参数:
字段名 类型 是否必填 描述
taskId string 任务编号
响应参数:
字段名 类型 是否必填 描述
code int

正确:200

错误:500

msg string

正确:成功

错误:错误原因

data string listData集合
listData集合说明
字段名 类型 是否必填 描述
type int

2至信链,目前只支持至信链

taskStatus int

标记任务状态,任务执行中:2

任务成功:7

任务失败:10

taskMsg string 失败情况下会有提示信息
seriesId string

系列Id,后面用户查询系列信息

txHash string

交易hash

chainTimestamp int64

链上交易时间戳

3)发行 数字商品
说明:商品上链,企业内外均不可重复nftid
接口:api/v1/product/create
请求方式:post
请求参数:
字段名 类型 是否必填 描述
merchantId int64 商户id,由薄盒分配
chainType int 上链类型:1 树图 2至信链
author string 创作家名,中文+英文(数字或符号为非法输入)不超过30个字符。
name string 数字藏品名字,中英文数字均可,不超过256个字符。
url string 介质url,不超过1024个字符
displayUrl string 预览图url,不超过1024个字符。(至信链浏览器展示预览图尺寸为290*290,请上传比例为1:1的图片)
desc string 数字商品简介,500个字符以内
publishCount int64 发行量,如果没有系列,就只能为1,如果有系列从1开始,比如如有100个,系列id范围则为[1-100],单次发行个数不超过1000,同系列下同介质个数总共不能超过5000
sellPrice int64 销售价格,默认是0,不可销售
seriesId string 系列id
metaData string 扩展字段,用户自定义,长度不超过1024个字符
signData string 签名:md5(chainType_author_name_publishCount_secretKey)
响应参数:
字段名 类型 是否必填 描述
code int

正确:200

错误:500

msg string

正确:成功

错误:错误原因

data string {"taskId":"任务编号"}
4)查询 数字商品发行结果
说明:任务Id查询钱包信息
接口:api/v1/user/query
例如:api/v1/user/query/C_908
请求方式:get
请求参数:
字段名 类型 是否必填 描述
taskId string 任务编号
响应参数:
字段名 类型 是否必填 描述
code int

正确:200

错误:500

msg string

正确:成功

错误:错误原因

data string json array-listData 数字商品信息
listData说明
字段名 类型 是否必填 描述
chainType int

上链类型:1树图2至信链

ntfId string

上链后的nftId

taskStatus string 标记任务状态,任务执行中:2,任务成功:7,任务失败:10
txHash string

交易hash

chainTimestamp int64

链上交易时间戳

5)通过用户MNS、手机号、地址查询账户下数字商品(待实现)
3. 错误码
错误码 描述
160001 已经存在该系列,请更换其他名称
160020 未找到数据
160030 费用不足