AVATA API 接入说明

AVATA API 使用流程

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

2、获取项目参数后，可按照 API 文档提供的网关鉴权签名示例生成签名参数
::: highlight green
在 Avata 服务平台完成企业认证后，系统会自动发放测试环境的项目参数至您的项目列表中，您可下载并在测试环境中使用
:::
3、通过平台网关鉴权后，可自行选择平台提供的不同版本接口服务，与区块链进行交互，实现业务对接

::: tip

• 测试环境的测试项目拥有初始的测试费用，可满足应用对接测试环境和进行接口调试
• 生产环境的每一次上链交易都收取一定的上链通信费用，需要您保证 AVATA 平台资金账户余额充足以满足业务使用需求
  :::
  4、在进行具体上链操作前，您需要优先使用「创建链账户」接口生成上链交易必需的链账户地址私钥（生成后的私钥由 AVATA 平台托管 ）
  ::: caution
  目前通过 Avata 平台创建的区块链账户地址生成即上链，会产生一笔上链交易所需费用（0.05元/个）。建议应用方按照实际会与底层链交互的活跃用户数进行链账户创建。
  :::

  AVATA API 接入说明

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

:::highlight orange 📌
API Key 用于网关鉴权，API Secret 用于接口服务调用签名。

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

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

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

3、AVATA API 版本选择建议

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

• 强烈建议您在创建项目时，选择平台托管模式

• 强烈建议您在调用 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	说明
500	INTERNAL_ERROR	内部服务错误
501	NOT_INPLEMENTED	暂不支持该类接口
502	UPSTREAM_INTERNAL_ERROR	上游服务错误
404	NOT_FOUND	访问信息不存在或暂时查询不到
403	FORBIDDEN	无访问权限
400	BAD_REQUEST	参数错误
400	DUPLICATE_REQUEST	重复请求
400	STATUS_ERROR	状态异常