天河链数字藏品-开放 API 文档
  1. v2
天河链数字藏品-开放 API 文档
  • v2
    • 用户链上身份注册
      POST
    • 用户链上身份秘钥修改
      POST
    • 用户链上身份查询
      POST
    • 数字商品发行
      POST
    • 数字商品交易
      POST
    • 交易结果查询
      POST
    • 销毁数字商品
      POST
    • 数字商品元数据上链存储
      POST
    • 根据交易哈希查询 TokenID
      GET
    • NFR 所属者链上地址查询
      POST
    • NFR 所属者判断
      POST
    • 补全NFR图片接口
      POST
    • 同步第三方 URI
      POST
    • 补全接口图片状态查询接口
      POST
    • 根据交易的操作Id批量查询 TokenID
      POST
  1. v2

数字商品发行

测试环境
https://test.api.tichain.tianhecloud.com
测试环境
https://test.api.tichain.tianhecloud.com
POST
/api/v2/nfr/publish
该接口在天河链发行数字商品(NFR),并自动派发给指定的用户地址(userID对应的钱包)上面,该接口会执行合约部署、并初始化指定数量的数字商品,并转移到该用户地址上(铸造)。
该接口执行时长和铸造数量正相关,一次调用不能连续发行10000个,建议在500左右,如果需要发行超过10000个,后面需要传递合约地址(contractAddress)参数(第一次调用会返回合约地址)。
⚠️发行接口会将交易提交到区块链上,当网络中交易量过大,链存在无法及时返回交易回执(数据的tokenId)的现象,所以需要通过返回的交易哈希(transactionHash)进一步查询和判断。
⚠️关于wait for mint消息是表明当前相同参数的请求还在执行,需要通过上一步的消息返回值进一步判断。天河链API接口为保证调用发布接口因网络异常终端,导致客户端未接收到消息,设计了参数缓存机制,在采用相同参数调用时,如果上一次执行没有成功放回,则返回wait for mint消息。

请求参数

Body 参数application/json
appId
string 
商家编号
必需
appKey
string 
商家秘钥
必需
userId
string 
用户ID
必需
一般为平台自己的用户ID,用来接收商品
userKey
string 
用户秘钥
必需
参照链上身份注册流程的秘钥
name
string 
专题名称
必需
字符长度不超过 42
pieceCount
integer 
NFR份数[1-10000]
必需
NFR份数[1-10000]
productIds
array[string]
商家数字商品ID数组
可选
可以是有意义的产品编号,每一个NFT一个
author
string 
作者
可选
字符长度不超过 120
feature
string 
作品特征、版权说明等
可选
每一次铸造都会上链,内容不宜过多,字符长度不超过 500
baseTokenId
integer 
自定义 tokenId 起始值
可选
创建合约有效 (若请求参数指定了 contractAddress ,则 baseTokenId 需设置为已发行 tokenId 的最大值。)
initPrice
string 
发行价格
可选
字符长度不超过 20
contractAddress
string 
合约地址参数
可选
用于在某合约上分批铸造,字符长度为 42
multiAddress
array[string]
发行目标地址组
可选
铸造后,直接转移到该地址,和需要发行的数量匹配或者唯一一个,该参数为空时,所有Token发给调用用户,有且只有一个发给唯一用户地址,正常一一匹配。场景:空投等。
示例
{
    "appId": "{{appId}}",
    "appKey": "{{appKey}}",
    "userId": "000000-0103-TEST01",
    "userKey": "123456",
    "productIds": ["0000A#01"],
    "name": "Welcome to WEB 3.0",
    "pieceCount": 1,
    "author": "TEST",
    "feature": "TiCHAIN CopyRight",
    "initPrice": "2",
    "operateId":"2342341231231212312311123121123"

}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.api.tichain.tianhecloud.com/api/v2/nfr/publish' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "",
    "appKey": "",
    "userId": "000000-0103-TEST01",
    "userKey": "123456",
    "productIds": ["0000A#01"],
    "name": "Welcome to WEB 3.0",
    "pieceCount": 1,
    "author": "TEST",
    "feature": "TiCHAIN CopyRight",
    "initPrice": "2",
    "operateId":"2342341231231212312311123121123"

}'

返回响应

🟢200成功
application/json
Body
code
integer 
消息码
必需
message
string 
消息
必需
data
object 
必需
contractAddress
string 
合约地址
必需
deployTransactionHash
string 
合约部署交易哈希
必需
products
array [object {5}] 
藏品列表
必需
示例
{
    "code": 0,
    "message": "success",
    "data": {
        "contractAddress": "0x0e4c4294a958ce951dac678e84ff72c8ad7e3e02",
        "deployTransactionHash": "0x64755713bd682ec7a0e045561622c5bb7f5d7e7f8722e73e86eb54fcb9e57c0b",
        "products": [
            {
                "transactionHash": "0xc1314c7c8ede20c7e5a59d78227c0981c42fa72af5ad2570bd37ecaf1a7b228d",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 9,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x34af008292b9a08b440c815bcce842832eab11707c5e532ad15deb5db530773c",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 11,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x2586f4fa3713532a096f84e2e5b8b36ad8374764933fe3d737a01bf823ac4a5f",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 15,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x9eb6e64230e98226930cc47c3a12346beaa307f20497ee4169cc618915af0e2d",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 16,
                "initPrice": "88"
            },
            {
                "transactionHash": "0xeb700d292b6ce7e3275cc8f75dbfa55232eda4c5a9fbffcb47ee5f08cd0d85df",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 14,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x61f30c78f221434dfc59401b73c3931b508ea3d91b955a8c389db0bb68c9223e",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 17,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x40a9a6165f3a993514fc770351e58e4ed1ab122bc7d638ee517fd7298a873cd6",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 13,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x6f05be386d81f3b127681259661819beb1ac8ac153d1d842d15e51077fa94161",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 12,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x789b531902795aec3b6fd7281555001660d39604190ad945f69085292343a723",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 8,
                "initPrice": "88"
            },
            {
                "transactionHash": "0x296ebee2f3b28dc06e69d9367ba2aa57f488a16ecd069fabf648f9f82faabf89",
                "productId": "",
                "address": "0x2a3d093c24b19c23d76a78ba473cd15f43be6d68",
                "tokenId": 10,
                "initPrice": "88"
            }
        ]
    }
}
修改于 2023-03-01 09:43:13
上一页
用户链上身份查询
下一页
数字商品交易
Built with