AVATA API 最佳实践
前置条件
1、应用方通过 AVATA 服务平台成功创建项目,并获取 API Key 和 API Secret;
2、应用方已成功设置了服务回调地址
3、确保向 AVATA 平台提供的服务回调地址可正常使用
上链交易结果回调和查询指引
重点步骤说明
步骤1
:应用方在调用上链接口前,需本地生成并保存 operation_id。
:::caution
operation_id 需要全局唯一,应用方系统中的每一个上链动作,关联一个独立的 operation_id,不同的上链动作的 operation_id 不能相同。
只要请求被 AVATA API 接收,就一定会被处理,在达到终态
之前,千万不要使用不同的 operation_id
发起相同的请求
,避免重复上链和重复扣费。
:::
步骤2
:AVATA API 上链请求会产生以下两种交易结果:
- 成功:HTTP 状态码为
2xx
; - 失败:HTTP 状态码非
2xx
,应用方可根据响应体中的 error message 去 AVATA 技术社区 查找对应失败原因的说明并执行下一步操作。
步骤3
:应用方订阅回调服务,等待回调服务通知上链交易结果
- 异步回调:交易完成后,AVATA 会将交易结果以回调通知的形式同步给应用方。
回调说明及推送参数可参考:交易结果异步回调通知;
步骤4
:应用方未收到回调,进行主动查询。如果步骤3在等待一定时间后(一般为10-20s左右)没有收到回调通知,需要主动查询。
:::caution
区块链交易上链为异步操作,强烈建议应用方采用推拉结合
结合的方式,保障上链结果同步的可靠性和时效性。
当网络问题或回调地址无法联通等原因,导致应用方无法接收到回调通知时,应用方必须主动调用查询上链交易结果接口
获取交易结果,不要完全依赖回调通知。
:::
发行 NFT 步骤示例
可参考:https://forum.avata.bianjie.ai/t/topic/154
上链交易排队状态查询
当链上交易量较大时,可能会出现交易上链拥堵、排队的情况,应用方可通过「上链交易排队状态查询接口」了解排队情况,并合理安排上链时间,错峰上链避免拥堵。
最后修改时间: 1 年前