跳转到内容

Chaingateway 开发者门户与 API 文档

Chaingateway 开发者门户介绍一套 REST API。它可以在 Ethereum、TRON、BNB Smart Chain、Bitcoin、Polygon、Arbitrum 和 Solana 上创建地址、发送交易、读取余额并接收 Webhook。请从快速入门开始:创建 API key,发送一个请求,再用一个 header 在 mainnet 与 testnet 之间切换。

我可以用 Chaingateway API 做什么?

Section titled “我可以用 Chaingateway API 做什么?”

你可以通过一套 REST 接口管理钱包、发送原生币和代币、读取区块链数据,并订阅支付通知。OpenAPI 文件列出了 200 多个操作。它们按链分组,各条 EVM 链上的模式相同。

任务典型端点支持的链
创建钱包地址POST /api/v2/{chain}/addressesEthereum、BSC、Polygon、Arbitrum、TRON、Solana
创建 Bitcoin 钱包及其地址POST /api/v2/bitcoin/walletsBitcoin
发送原生币POST /api/v2/{chain}/transactions全部七条链
发送代币POST /api/v2/{chain}/transactions/erc20、/bep20、/trc20、/SPL除 Bitcoin 外的所有链
读取余额和区块GET /api/v2/{chain}/balances/{address}全部七条链
接收支付通知POST /api/v2/{chain}/webhooks除 Solana 外的所有链
读取市场价格GET /api/v2/market/price/{crypto}/{fiat}与链无关

Solana 没有 Webhook 端点,因此 Solana 上的充值只能通过读取余额或交易来发现。钱包是非托管的:你要么设置一个密码来保护存储的密钥,要么在响应中拿到私钥并自行保管。钱包管理解释了这两种模式。

集成流程分四步:创建 API key、创建地址、发送或读取交易、接收 Webhook 1. 创建 API key 控制台,API 令牌 2. 创建地址 POST /api/v2/{chain}/addresses 3. 发送并读取交易 POST 和 GET /api/v2/{chain}/transactions 4. 接收 Webhook POST /api/v2/{chain}/webhooks,你的服务器返回 200
集成的常见顺序。第 3 步和第 4 步可以并行进行。

在控制台创建 API key,然后在 Authorization header 中以 Bearer 令牌的形式发送它。新账户享有 7 天免费试用,开始时无需绑卡,也无需身份验证。下面的请求读取 Ethereum 的最新区块号。

Terminal window
curl --request GET \
--url https://app.chaingateway.io/api/v2/ethereum/blocks/number \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

没有有效令牌的请求会返回 HTTP 401,响应体为 {"message":"Unauthenticated."}。如果要在测试网络上执行同一个调用,请添加 header X-Network: testnet。省略该 header 或将其设为 mainnet,则使用主网络。快速入门用四种语言演示了账户设置、header 和一个 POST 请求。

共有七条区块链可用,每条都有 mainnet 和 testnet。测试网分别是:Ethereum 的 Sepolia、TRON 的 Nile、BNB Smart Chain testnet、Bitcoin testnet3、Polygon 的 Amoy、Arbitrum Sepolia 和 Solana devnet。支持的网络列出了每个网络对应的 X-Network 值,并说明了这两个 header 取值的含义。

在哪里可以找到完整的 API 参考?

Section titled “在哪里可以找到完整的 API 参考?”

交互式参考位于 chaingateway.io/docs。它由同一份 openapi.yaml 文件生成,你可以把这份文件导入 Postman、Insomnia 或代码生成器。每个操作都列出了参数、地址的校验规则和示例响应,其中包括错误响应体。

所有响应共用一个 JSON 外层结构,包含 status、ok 和 message 字段。成功的调用会增加 data,校验失败则会增加 errors 对象。常见问题给出了两种情况的示例。

每个端点都返回 JSON。成功的调用会返回 ok: true,同时带有 HTTP 状态码和 data 字段。下面的示例是 GET /api/v2/ethereum/gasprice 的响应。

{
"ok": true,
"status": 200,
"message": "Successfully parsed",
"data": { "gasPrice": "12.28" }
}

校验失败会返回状态码 422,并指出每个被拒绝的字段。区块链错误也使用同一个外层结构,例如 gas 余额不足。钱包密码错误会返回 401,消息为 Wrong password provided。请这样编写客户端:先检查 ok,当它为 false 时记录 message 和 errors。

{
"status": 422,
"ok": false,
"message": "Data validation failed",
"errors": { "password": ["The password field is required."] }
}

请选择与你手头任务相符的页面:

这些文档使用的 HTTP 与令牌约定由以下公开标准定义: