帮助文档
文档中心
开发者文档
  • AVATA API 文档
  • 底层链 SDK 文档
开发者社区
区块链浏览器
  • 文昌链网浏览器
  • 文昌链极速网
  • 文昌链-天舟
  • 文昌链-神舟
  • 文昌链-天和
关于文昌链
文档中心
开发者文档
  • AVATA API 文档
  • 底层链 SDK 文档
开发者社区
区块链浏览器
  • 文昌链网浏览器
  • 文昌链极速网
  • 文昌链-天舟
  • 文昌链-神舟
  • 文昌链-天和
关于文昌链
  1. 用户指南
  • 平台介绍
    • 平台简介
    • 核心功能
    • 基础术语
    • 文昌链极速网服务
    • 第三方支付服务
  • 用户指南
    • AVATA 接入流程
    • AVATA API 接入说明
    • AVATA API 最佳实践
    • 费用说明
  • 常见问题
    • AVATA 平台 NFT 元数据规范
    • AVATA 测试项目如何充值能量值
    • AVATA 技术社区使用指南
    • 原生 NFT 和原生 MT 区别
    • operation_id 的作用
    • AVATA API & 底层链 SDK 如何选择
    • 如何开具发票
    • 获取合作协议
    • 网信办备案填报指南
    • 更多问题 >>
  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 SDK#

Java 语言版本:https://github.com/bianjieai/avata-sdk-java
Go 语言版本:https://github.com/bianjieai/avata-sdk-go
PHP 语言版本:https://github.com/bianjieai/avata-sdk-php

AVATA API 错误码汇总#

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

扫码加入文昌链微信技术交流群

在这里,获得 Avata 使用上的任何帮助,快速上手让你的研测效率大幅提升

扫码添加小助手
修改于 2024-08-01 06:03:36
上一页
AVATA 接入流程
下一页
AVATA API 最佳实践
Built with