Avata 帮助文档-测试
  1. 用户指南
Avata 帮助文档-测试
  • Avata 平台文档
    • 平台介绍
      • 平台简介
      • 核心功能
      • 基础术语
      • 平台服务
        • 文昌链极速网
        • 文昌链存证服务
        • 文昌链域名服务
        • 第三方支付服务
    • 用户指南
      • 接入流程
      • AVATA API 接入说明
      • AVATA API 最佳实践
      • 费用说明
    • 常见问题
      • AVATA 平台 NFT 元数据规范
      • Avata 测试项目如何充值能量值
      • Avata 技术社区使用指南
      • 原生 NFT 和原生 MT 区别
      • operation_id 的作用
      • AVATA API & 底层链 SDK 如何选择
      • 如何开具发票
      • 申请平台合作协议
      • 网信办备案填报指南
      • 变更认证主体流程说明
      • 更多问题 >>
  • AVATA API 文档
    • AVATA API 文档
      • 接入说明
        • 网关鉴权签名示例
        • 交易结果异步回调通知
      • AVATA v3 API 文档
        • API 版本简介
        • 链账户接口
          • 创建链账户
          • 批量创建链账户
          • 查询链账户
        • 原生模块
          • 关于原生模块
          • NFT 接口
            • 创建 NFT 类别
            • 转让 NFT 类别
            • 查询 NFT 类别
            • 查询 NFT 类别详情
            • 发行 NFT
            • 转让 NFT
            • 编辑 NFT
            • 销毁 NFT
            • 查询 NFT
            • 查询 NFT 详情
            • 查询 NFT 操作记录
          • MT 接口
            • 创建 MT 类别
            • 查询 MT 类别
            • 查询 MT 类别详情
            • 转让 MT 类别
            • 发行 MT
            • 增发 MT
            • 转让 MT
            • 编辑 MT
            • 销毁 MT
            • 查询 MT
            • 查询 MT 详情
            • 查询 MT 操作记录
            • 查询 MT 余额
          • 区块链存证接口
            • 数字作品存证接口
          • 查询链账户操作记录
          • 查询上链交易结果
          • 查询枚举值列表
        • 智能合约模块
          • 关于智能合约模块
          • NFT 接口
            • 创建 NFT 类别
            • 转让 NFT 类别
            • 查询 NFT 类别
            • 查询 NFT 类别详情
            • 发行 NFT
            • 转让 NFT
            • 编辑 NFT
            • 销毁 NFT
            • 查询 NFT
            • 查询 NFT 详情
            • 查询 NFT 操作记录
          • 合约服务接口
            • Avata API 合约服务使用说明
            • 调用合约
            • 查询合约
          • Web3 域名服务接口
            • 注册域名
            • 转让域名
            • 查询域名
            • 查询用户域名
            • 设置域名解析
            • 查询域名解析
            • 设置域名反向解析
            • 查询域名反向解析
            • 续购域名
          • 查询链账户操作记录
          • 查询上链交易结果
          • 查询枚举值列表
        • 购买能量值接口
          • 购买能量值
          • 批量购买能量值
          • 查询能量值购买结果
          • 查询能量值购买结果列表
        • 钱包服务接口
          • 创建钱包用户
          • 更新钱包用户
          • 查询钱包用户信息
          • 认证钱包用户
      • AVATA v2 API 文档
        • API 版本简介
        • 链账户接口
          • 创建链账户
          • 批量创建链账户
          • 查询链账户
          • 查询链账户操作记录
        • NFT 接口
          • NFT/MT 元数据规范
          • 创建NFT类别
          • 查询NFT类别
          • 查询NFT类别详情
          • 转让NFT类别
          • 发行 NFT
          • 转让 NFT
          • 编辑 NFT
          • 销毁 NFT
          • 查询 NFT
          • 查询 NFT 详情
          • 查询 NFT 操作记录
        • web3域名服务接口
          • 注册域名
          • 转让域名
          • 查询域名
          • 查询用户域名
        • 合约服务接口
          • Avata API 合约服务使用说明
          • 调用合约
          • 查询合约
        • 购买能量值接口
          • 购买能量值
          • 批量购买能量值
          • 查询能量值购买结果
          • 查询能量值购买结果列表
        • 区块链存证接口
          • 数字作品存证接口
        • 钱包服务接口
          • 创建钱包用户
          • 更新钱包用户
          • 查询钱包用户信息
          • 认证钱包用户
        • 查询交易结果接口
          • 查询上链交易结果
      • AVATA v1 API 文档
        • API 版本简介
        • 链账户接口
          • 创建链账户
          • 批量创建链账户
          • 查询链账户
          • 查询链账户操作记录
        • NFT 接口
          • 创建 NFT 类别
          • 查询 NFT 类别
          • 查询 NFT 类别详情
          • 转让 NFT 类别
          • 发行 NFT
          • 转让 NFT
          • 编辑 NFT
          • 销毁 NFT
          • 批量发行 NFT
          • 批量转让 NFT
          • 批量编辑 NFT
          • 批量销毁 NFT
          • 查询 NFT
          • 查询 NFT 详情
          • 查询 NFT 操作记录
        • MT 接口
          • 创建 MT 类别
          • 查询 MT 类别
          • 查询 MT 类别详情
          • 转让 MT 类别
          • 增发 MT
          • 发行 MT
          • 转让 MT
          • 编辑 MT
          • 销毁 MT
          • 查询 MT
          • 查询 MT 操作记录
          • 查询 MT 余额
          • 查询 MT 详情
        • 区块链存证接口
          • 数字作品存证接口
        • 购买能量值接口
          • 购买能量值
          • 批量购买能量值
          • 查询能量值购买结果
          • 查询能量值购买结果列表
        • 查询交易结果接口
          • 查询上链交易结果
          • 查询上链交易排队状态
  • AVATA SDK 文档
    • AVATA SDK 文档
      • AVATA v3 SDK 文档
        • Go 语言
        • JAVA 语言
      • AVATA v1 SDK 文档
        • Go 语言
        • JAVA 语言
        • PHP 语言
  • 底层链 SDK 文档
    • 底层链 SDK 文档
      • 底层链介绍
      • 底层链 API 接入说明
      • Go 语言接入教程
      • JAVA 语言接入教程
      • 文昌链最佳实践建议
  1. 用户指南

AVATA API 接入说明

AVATA API 使用流程

1、项目创建成功后,系统会自动生成 API 请求参数,您需下载并保存(请仔细保管,谨防丢失)

2、获取项目参数后,可按照 API 文档提供的网关鉴权签名示例生成签名参数

在 Avata 服务平台完成企业认证后,系统会自动发放测试环境的项目参数至您的项目列表中,您可下载并在测试环境中使用

3、通过平台网关鉴权后,可自行选择平台提供的不同版本接口服务,与区块链进行交互,实现业务对接

提示

  • 测试环境的测试项目拥有初始的测试费用,可满足应用对接测试环境和进行接口调试
  • 生产环境的每一次上链交易都收取一定的上链通信费用,需要您保证 AVATA 平台资金账户余额充足以满足业务使用需求

4、在进行具体上链操作前,您需要优先使用「创建链账户」接口生成上链交易必需的链账户地址私钥(生成后的私钥由 AVATA 平台托管 )

注意

目前通过 Avata 平台创建的区块链账户地址生成即上链,会产生一笔上链交易所需费用(0.05元/个)。建议应用方按照实际会与底层链交互的活跃用户数进行链账户创建。

AVATA API 接入说明

1、只有完成企业认证并获得 API Key 和 API Secret 的应用方才可以调用 AVATA API。

📌

API Key 用于网关鉴权,API Secret 用于接口服务调用签名。

2、不同环境的接口请求路径 Path Url 不同,且项目参数不能互通共用,在做接口请求时,请仔细选择访问环境并配置正确的访问域名:

💡

-测试环境的访问域名为: https://stage.apis.avata.bianjie.ai
-生产环境的访问域名为: https://apis.avata.bianjie.ai

可按照下图在开发者文档中切换环境来查看对应接口访问路径

image.png

3、AVATA API 版本选择建议

提示

如果您没有任何的区块链底层开发经验,也不了解任何关于智能合约相关的知识,建议您做如下选择:

  • 强烈建议您在创建项目时,选择平台托管模式
  • 强烈建议您在调用 API 时,选择使用AVATA v3 API-原生模块 或 AVATA v1 API

AVATA API 请求示例

  • Java 语言版本:https://gitee.com/wangenlai2010.vicp.cc/AvataAPIDemo.git

  • Go 语言版本:https://gitee.com/wangenlai2010.vicp.cc

以上示例来自文昌链技术交流群「上海云之旌网络科技有限公司」布鲁克,感谢@布鲁克的技术贡献

  • PHP 语言版本:https://github.com/bianjieai/avata-demos/tree/main/php

以上示例来自文昌链技术交流群「河北曼象无限科技发展有限公司」0307,感谢 @0307 的技术贡献

AVATA API 错误码汇总

HTTP 状态码 CODE 说明
500 INTERNAL_ERROR 内部服务错误
501 NOT_INPLEMENTED 暂不支持该类接口
502 UPSTREAM_INTERNAL_ERROR 上游服务错误
404 NOT_FOUND 访问信息不存在或暂时查询不到
403 FORBIDDEN 无访问权限
400 BAD_REQUEST 参数错误
400 DUPLICATE_REQUEST 重复请求
400 STATUS_ERROR 状态异常
上一页
接入流程
下一页
AVATA API 最佳实践
Built with