帮助文档

设置域名解析

生产环境

POST

https://apis.avata.bianjie.ai/v3/evm/ns/resolves/{owner}/{name}

AVATA API 文档/AVATA API 文档/AVATA v3 API 文档/智能合约模块/Web3 域名服务接口

限流规则：一个域名一天内（自然天）允许解析的次数不超过10次

请求参数

Path 参数

owner

string

域名拥有者地址

必需

name

string

域名名称

必需

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

resolve_type

enum<integer>

域名解析类型

必需

1：链账户 2：文本

枚举值:

addr

object

链账户

可选

当 resolve_type 为 1 时，该字段为必填

addr_value

string

链账户地址

可选

默认值为当前域名的 owner

<= 128 字符

block_chain

enum<integer>

底层区块链

必需

1000：文昌链 - 天舟； 1001：文昌链 - 天和； 1002：文昌链 - 神舟

枚举值:

100010011002

text

object

文本数据

可选

当 resolve_type 为 2 时，该字段为必填

key

string

文本数据 key

必需

key 可选的标准值有：
email (电子邮箱地址)；
url (网址)；
avatar (用作头像或标识的图像的网址),description(域名的描述信息)；
notice (关于域名的通知)；
keywords (逗号分隔的关键字列表，按重要性由高到低排列，与此字段有交互的客户端可以通过设置一个阈值来选择忽略哪些内容)

<= 32 字符

text_value

string

文本数据值

必需

<= 512 字符

operation_id

string

必需

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

>= 1 字符<= 64 字符

正则匹配:

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

示例

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apis.avata.bianjie.ai/v3/evm/ns/resolves//' \
--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 ''

返回响应

🟢200successful operation

application/json

Body

data

object

必需

示例

{
  "data": {}
}

🟠400failed operation

修改于 2023-08-21 07:04:33

查询用户域名

查询域名解析