跳转到内容

面向开发者的区块链 API 常见问题

本常见问题解答了开发者对 Chaingateway API 最常提出的问题:如何身份验证、有哪些网络、如何测试、错误是什么样的,以及如何获得支持。Chaingateway 是一套 REST API,应用可以用它创建钱包、发送交易、读取区块链数据并接收 Webhook。每个回答都链接到包含详细说明的页面。

请求失败时的处理:先读取 JSON 响应体中的 ok 字段和 status,再看 message 和 errors,修正请求;如果原因在服务器一侧,则联系支持 发送请求 Authorization: Bearer YOUR_API_KEY 读取 JSON 响应体中的 ok 和 status ok: true 表示调用成功 ok: false?读取 message 和 errors 401 令牌或密码问题,422 校验或余额问题 修正请求,或联系支持 support@chaingateway.io
下面各个回答所描述的错误处理循环。

如何开始使用并完成身份验证?

Section titled “如何开始使用并完成身份验证?”

先注册账户,在控制台创建 API key,然后以 Bearer 令牌的形式发送它。7 天免费试用无需绑卡。快速入门演示了第一个请求。

Chaingateway.io 是什么? Chaingateway.io 是一个提供区块链 API 解决方案的平台, 使开发者能够将区块链功能集成到自己的应用程序中。 一套 REST 接口即可覆盖多个区块链网络上的钱包、交易、余额、区块和 Webhook。

我该如何开始使用 Chaingateway.io? 要开始使用,请在 Chaingateway.io 上注册一个账户。注册后, 你可以在控制台的 API 令牌页面创建 API key。你需要用它对 你的 API 请求进行身份验证。文档提供了指南和示例,帮助你 将 API 集成到自己的应用程序中。

如何对我的 API 请求进行身份验证? 向 Chaingateway.io 发起的 API 请求需要使用 API key 进行身份验证。登录后在控制台创建该 key,并在 HTTP 请求的 header 中以 Bearer 令牌的形式发送:

Authorization: Bearer YOUR_API_KEY

没有有效令牌的请求会返回 HTTP 401,响应体为 {"message":"Unauthenticated."}。不要把 key 放进客户端代码或代码仓库。

API 是否有使用限制? 是的,使用限制取决于你的订阅套餐。更高级别的 套餐提供更高的使用配额。有关限制和价格的详细信息,请参阅我们的定价页面。 例如,创建的地址数量超过套餐允许的上限时,会返回 状态码 422,消息为 Your address limit exceeded. Please upgrade your plan。

API 支持七条区块链,每条都有 mainnet 和 testnet,并在这些链上提供钱包管理、交易处理、Webhook 和数据获取功能。支持的网络列出了这些网络和 X-Network header 的取值。

支持哪些区块链网络? Chaingateway.io 支持以下区块链网络:

  • Ethereum(mainnet 和 Sepolia)
  • Binance Smart Chain(mainnet 和 testnet)
  • Bitcoin(mainnet 和 testnet3)
  • Polygon(mainnet 和 Amoy)
  • Tron(mainnet 和 Nile)
  • Arbitrum(mainnet 和 Arbitrum Sepolia)
  • Solana(mainnet 和 devnet)

有关如何访问不同网络的更多信息,请参阅支持的网络。

Chaingateway.io 提供哪些类型的 API? API 涵盖以下领域:

  • 钱包管理:创建和管理钱包。
  • 交易处理:发送原生币和代币,并读取交易。
  • Instant Payment Notification:接收有关区块链事件的 Webhook 通知。
  • 数据获取:获取余额、区块和市场价格等区块链数据。

OpenAPI 文件列出了 200 多个操作。API 参考文档记录了其中的每一个。

我可以在沙盒环境中测试这些 API 吗? 可以,每条受支持的区块链都有 testnet。在请求中添加 header X-Network: testnet,请求就会在测试网络上运行。没有该 header,或使用 X-Network: mainnet 时,请求会在主网络上运行。这样你无需转移真实资金就能测试你的集成。

有关如何访问不同网络,请参阅支持的网络。

请检查每个响应的 ok 字段,当它为 false 时记录 message 和 errors。投递失败的 Webhook 不会自动重试,你需要自己列出它们并重新发送。

如何处理来自 API 的错误? 如果 API 请求失败,响应中会包含指明问题的状态码和消息。OpenAPI 文件记录了以下状态码:

  • 400:Bad Request。示例:无法读取 TRC20 合约。
  • 401:Unauthorized。API key 无效或缺失,或者钱包密码错误。
  • 404:Not Found。示例:不存在的 Webhook id。
  • 422:Unprocessable Entity。请求格式正确,但校验失败,或区块链拒绝了该交易,例如因为余额不足。

更多详情请参阅我们文档中的错误处理章节。我们还会在响应体中添加有用的信息。以下是一个示例:

{
"status": 422,
"ok": false,
"message": "insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000",
"errors": []
}
{
"status": 422,
"ok": false,
"message": "Data validation failed",
"errors": {
"password": ["The password field is required."]
}
}

如何获得收款通知? 用 POST /api/v2/{chain}/webhooks 创建一个 Webhook。之后,每有一笔匹配的交易,Chaingateway 就会向你的 URL 发送一个 HTTP POST 请求。Webhook 适用于 Ethereum、BNB Smart Chain、Polygon、Arbitrum、TRON 和 Bitcoin,不适用于 Solana。

投递失败的通知不会自动重试。用 GET /api/v2/{chain}/webhooks/notifications/failed 列出失败的通知,再用 POST /api/v2/{chain}/webhooks/notifications/{id}/retry 重新发送其中一条。请参阅 Webhook 和 Webhook 安全。

应该使用哪种钱包类型? 长期使用的地址请使用密码保护钱包。创建地址时发送 password,之后的交易用该密码签名。非安全钱包只用于临时地址,因为私钥会在响应中返回,你必须自行保存。Chaingateway 不存储密码,也无法恢复丢失的密码。请参阅钱包管理。

在哪里监控使用情况并获得支持?

Section titled “在哪里监控使用情况并获得支持?”

我该如何监控我的 API 使用情况? 你可以从控制台监控你的 API 使用情况,控制台提供 有关请求次数、数据使用情况以及遇到的任何 错误的分析和报告。

如果遇到问题,我该如何获得支持? 如需支持,你可以通过控制台中提供的支持门户与我们联系。我们还提供社区论坛和详尽的文档,可以帮助解决常见问题。

如有紧急事项,请通过电子邮件 support@chaingateway.io、Telegram 或网站上的网页聊天直接联系我们的支持团队。

我们还运营着一个 Telegram 社区,你可以在那里找到有用的讨论。

是否有推荐或合作伙伴计划? 是的,我们为有兴趣推广 Chaingateway.io 的开发者和企业提供推荐和合作伙伴计划。 更多信息请访问 我们的合作伙伴页面。

在哪里可以找到关于 Chaingateway.io 的最新更新和新闻?

通过关注我们的博客并订阅我们的 新闻通讯,随时了解最新新闻、功能发布和公告。