← 博客
10 分钟阅读
|
发布于
|
更新于

区块链 API 有何作用,为何要使用它

区块链 API 让您的软件无需运行节点,即可通过 HTTPS 读取链上数据并发送交易。本文介绍它涵盖的功能、身份验证方式与适用边界,列出各链的原生接口、常见使用场景与集成流程的五个步骤,并说明它不解决哪些问题,以及使用时的主要风险。

章节
C
Chaingateway Team
区块链专家

审核: Maurice Sobiera

区块链 API 是一种 Web 接口,让您的软件无需运行节点即可读取链上数据并发送交易。您发送 HTTPS 请求并接收 JSON,无需直接使用每条链的原生协议。Chaingateway 的 API 以同一种身份验证方式覆盖七条链。

区块链为何需要 API 层?

每条链都有自己的原生接口,而这些接口都不是为应用开发者设计的。节点暴露的是底层方法、原始编码以及它自己的地址格式。下表列出了在没有 API 层的情况下,开发者需要从哪里开始:

链系列原生接口需要自行处理的内容
Ethereum、BNB Smart Chain、Polygon、Arbitrum自有节点或托管端点上的 JSON-RPC十六进制编码的数量、代币转账的 ABI 解码、Gas 设置
比特币Bitcoin Core RPCUTXO 处理、手续费估算、钱包文件
Tronjava-tron 节点接口、HTTP 与事件插件能量与带宽资源、基于 protobuf 的交易

API 层为这些接口提供了统一的请求风格。在以太坊、BNB Smart Chain、Polygon、Arbitrum、Tron 和 Solana 上,创建地址都是 POST /api/v2/<chain>/addresses。比特币则使用钱包,通过 POST /api/v2/bitcoin/wallets 创建。凡是支持代币的链,代币转账都遵循相同的模式。仍然存在的差异,是各链之间真实存在的差异,例如 Tron 的资源或比特币的手续费。文章区块链 API 与节点对比更详细地比较了这两种方式。

区块链 API 可以做什么?

您可以创建地址、转移原生币和代币、读取区块与交易,并接收通知。在 Chaingateway API 参考中,主要分为以下几类:

  • 地址:创建(可选择是否设置加密私钥的密码)、导入和列出地址
  • 交易:发送原生货币、ERC20/TRC20/BEP20 代币和 ERC721 NFT,以及读取交易
  • 网络数据:最新区块号,以及 EVM 链上的 Gas 价格
  • Webhook:注册一个地址和一个 URL,之后在有匹配的交易发生时接收 POST 请求
  • 仅限 Tron:为获取能量与带宽而冻结和委托资源

并非每条链都具备所有功能组。例如,Solana 没有 Webhook。OpenAPI 文件准确列出了每条链存在哪些端点。

身份验证如何工作?

每个请求都在 Authorization 请求头中携带一个 Bearer 令牌,其定义见 RFC 6750。默认使用主网。如需使用测试网,请添加请求头 X-Network: testnet:

Terminal window
curl https://app.chaingateway.io/api/v2/ethereum/blocks/number \
-H "Authorization: Bearer $CHAINGATEWAY_TOKEN" \
-H "X-Network: testnet"

不带第二个请求头的同一调用,返回的是主网最新区块。测试网包括以太坊的 Sepolia、Tron 的 Nile、Polygon 的 Amoy 和 Solana 的 Devnet 等。完整列表见支持的网络页面。请将令牌保存在您的服务器上。任何持有它的人都可以使用您的账户。

哪些使用场景适合区块链 API?

收款、充值监控和代币分发是常见的场景。商店为每个订单分配一个独立地址,并为其注册一个 Webhook。交易所或钱包服务对用户充值也是如此。向大量收款方支付代币的项目,则为每位收款方发送一个转账请求。供应链文章介绍了一个带发票引用的付款流程。

本文早期版本还将去中心化应用、身份验证和智能合约创建列为 API 的功能。但该 API 并不部署智能合约,身份验证也不属于它的功能。去中心化应用自身的逻辑存在于您用其他工具部署的合约中。API 则是您的服务器与这些合约周边链上环境通信的方式。

一次集成是什么样子的?

一次收款集成包含五个步骤,每个步骤都只需一个请求:

  1. 为订单或用户创建地址:POST /api/v2/ethereum/addresses,并附带 password。响应中包含新地址。
  2. 使用 POST /api/v2/ethereum/webhooks 为该地址注册 Webhook,并在 url 中填入您的接收地址。
  3. 向付款方展示该地址。
  4. 您的接收端会收到一个 POST 请求,其中包含交易 ID、发送方、接收方、区块号和类型。它应以成功状态码作出响应。
  5. 使用 POST /api/v2/ethereum/transactions 继续转出资金;如果是代币,则使用 .../transactions/erc20。

先使用 X-Network: testnet 测试以上五个步骤。测试网代币没有价值,因此出错也没有损失。

区块链 API 不做什么?

它不会改变链本身的运作方式。需要提前规划的局限包括:

  • 交易仍可能失败,例如 Gas 不足。确认时间由链决定,而非由 API 决定。
  • Webhook 不会自动重试。失败的通知会被列出,您需要请求重新发送。
  • 密钥需要谨慎处理。未设密码创建的钱包会在响应中返回其私钥。设置密码后,私钥会以加密形式存储在 Chaingateway 一侧。Chaingateway 不保存密码,因此密码丢失即意味着钱包无法恢复。
  • 服务商仍是一项依赖。请为您创建的每个交易 ID 保留您自己的记录。

我们如何撰写这些文章

准备好自己动手构建了吗? 获取你的 API key — 7 天试用,无需信用卡 — 或查看 区块链 API 获取完整的 endpoint 参考。

C
Chaingateway Team
区块链专家

Chaingateway 团队致力于为全球开发者简化区块链集成。