创建NFT类别

生产环境

https://apis.avata.bianjie.ai

POST

/v2/nft/classes

AVATA API 文档/AVATA API 文档/AVATA v2 API 文档/NFT 接口

NFT 类别是底层区块链对同一属性或类型资产的识别和集合，方便资产发行方对链上资产进行管理和查询，所以在发行 NFT 前，需要先创建 NFT 类别，用以声明其抽象属性。
在 AVATA v2 版本中，每一个 NFT 类别相当于一个链上智能合约（class_id 相当于智能合约地址）,由 AVATA 平台根据接口请求参数自动执行链上合约部署，无需应用方关心复杂的智能合约编写及部署逻辑。

请求参数

Header 参数

Content-Type

string

必需

固定值：application/json

X-Api-Key

string

必需

项目 API Key，用于 API 访问鉴权

X-Timestamp

string

必需

时间戳，1970年1月1日0点0分0秒到现在的毫秒数

X-Signature

string

必需

API 签名，算法为SHA256(Params+Timestamp+ApiSecret)

Body 参数application/json

name

string

名称

必需

NFT 类别名称，由创建者自定义

>= 1 字符<= 20 字符

uri

string

链外资源标识符

可选

指该 NFT 类别在链外的元数据存储地址或其他链外资源的标识
元数据规范建议参考：https://forum.avata.bianjie.ai/t/topic/81

<= 256 字符

symbol

string

标识

必需

NFT 类别标识，用于快速识别和查询该类 NFT 资产

>= 3 字符<= 32 字符

owner

string

NFT 类别权属者

必需

NFT 类别权属者地址，拥有在该 NFT 类别中发行 NFT 的权限。支持任一 AVATA 平台内合法链账户地址

<= 128 字符

editable_by_owner

enum<integer>

权限控制

可选

NFT 类别权限的控制功能，此类别下某一 NFT 的持有者可以编辑该 NFT
1 可编辑 0 不可编辑

枚举值:

默认值:

editable_by_class_owner

enum<integer>

权限控制

可选

NFT 类别权限的控制功能，此 NFT 类别的权属者可以编辑这个类别下所有的 NFT
1 可编辑
0 不可编辑

枚举值:

默认值:

operation_id

string

操作ID

必需

保证幂等性，避免重复请求，保证对于同一操作发起的一次请求或者多次请求的结果是一致的；由接入方生成并自行维护、针对每个 Project ID 唯一的、不超过 64 个大小写字母、数字、-、下划线的字符串

>= 1 字符<= 64 字符

正则匹配:

^[a-zA-Z0-9_-]+$

示例

{
    "name": "string",
    "uri": "string",
    "uri_hash": "string",
    "symbol": "string",
    "owner": "string",
    "editable_by_owner": 0,
    "editable_by_class_owner": 0,
    "operation_id": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apis.avata.bianjie.ai/v2/nft/classes' \
--header 'X-Api-Key;' \
--header 'X-Api-Key;' \
--header 'X-Timestamp;' \
--header 'X-Timestamp;' \
--header 'X-Signature;' \
--header 'X-Signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "uri": "string",
    "uri_hash": "string",
    "symbol": "string",
    "owner": "string",
    "editable_by_owner": 0,
    "editable_by_class_owner": 0,
    "operation_id": "string"
}'

返回响应

🟢200successful operation

application/json

Body

data

object

正确返回值

必需

示例

{
    "data": {}
}

🟠400failed operation

NFT/MT 元数据规范

查询NFT类别