创建 NFT 类别

生产环境

POST

/v3/native/nft/classes

AVATA API 文档/AVATA API 文档/AVATA v3 API 文档/原生模块/NFT 接口

NFT 类别是 IRITA 底层链对同一资产类型的识别和集合，方便资产发行方对链上资产进行管理和查询。所以在发行 NFT 前，都需要创建 NFT 类别，用以声明其抽象属性。

请求参数

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

名称

必需

>= 1 字符<= 20 字符

class_id

string

可选

NFT 类别 ID，仅支持小写字母及数字，以字母开头（该值若不填，则会由 AVATA 平台自动生成）

>= 3 字符<= 32 字符

symbol

string

可选

标识（该值若不填，则以空值上链）

>= 3 字符<= 32 字符

description

string

可选

描述（该值若不填，则以空值上链）

<= 300 字符

uri

string

链外数据链接

可选

<= 256 字符

uri_hash

string

可选

链外数据 Hash （该值若不填，则以空值上链）

<= 512 字符

data

string

可选

自定义链上元数据（该值若不填，则以空值上链）

<= 1024 字符

editable_by_owner

enum<integer>

可选

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

枚举值:

1 0

默认值:

owner

string

必需

NFT 类别权属者地址，必须为应用持有地址

<= 128 字符

operation_id

string

必需

操作 ID，保证幂等性；由接入方生成的唯一的、大小写敏感、不超过 64 个 ASCII 字符的字符串

>= 1 字符<= 64 字符

示例

{
  "name": "string",
  "class_id": "string",
  "symbol": "string",
  "description": "string",
  "uri": "string",
  "uri_hash": "string",
  "data": "string",
  "editable_by_owner": 1,
  "owner": "string",
  "operation_id": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apis.avata.bianjie.ai/v3/native/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",
    "class_id": "string",
    "symbol": "string",
    "description": "string",
    "uri": "string",
    "uri_hash": "string",
    "data": "string",
    "editable_by_owner": 1,
    "owner": "string",
    "operation_id": "string"
}'

返回响应

🟢200successful operation

application/json

Body

data

object

正确返回值

必需

示例

{
  "data": {}
}

🟠400failed operation

修改于 2023-10-26 02:42:19

关于原生模块

查询 NFT 类别