Skip to Content
快速开始

RPC Gateway 快速开始

RPC Gateway 为应用提供稳定的区块链访问入口。你的应用只需要保存一个 App API Key，并调用控制台展示的 Gateway 地址。

对于 Accelerator 已缓存的少量只读方法，你可以不配置 Endpoint 直接开始；需要完整方法覆盖、稳定回源、写请求或未缓存数据时，再为 Gateway 配置自己的 Endpoint。

开始前确认

  • 账户已由平台管理员开通，并且可以登录控制台。
  • 目标链和网络列在链与网络中。
  • 如果需要 Accelerator 范围外的方法，你可以通过 Providers 同步服务商与平台共同支持的网络，也可以手工添加可用的上游 RPC 地址。

完成首次调用

1. 创建 App

在控制台进入 Apps，创建 App 并选择需要的网络。系统会为 App 生成 API Key 和对应网络的 Gateway。

请安全保存 API Key。它可以在 App 的密钥管理页面再次查看，也可以轮换或撤销。

2. 复制 Gateway 地址

从 App 或 Gateway 页面复制完整的 Access Point。地址中的 Host 决定链、网络和协议，API Key 决定请求属于哪个 App，因此不要自行拼接生产域名。

下面使用 Ethereum Mainnet 的 Host 形式和 Bearer 鉴权：

export RPC_URL='https://ether-jsonrpc.<gateway-domain>'
export APP_API_KEY='<app_api_key>'

也可以使用控制台提供的 Path Key 地址：

https://ether-jsonrpc.<gateway-domain>/<app_api_key>

3. 无 Endpoint 发起第一条请求

eth_blockNumber 属于 EVM Accelerator 方法。只要共享缓存命中，即使 Gateway 没有 Endpoint 也能返回结果：

curl "$RPC_URL" \
  -H "Authorization: Bearer $APP_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"jsonrpc":"2.0","id":1,"method":"eth_blockNumber","params":[]}'

成功响应示例：

{"jsonrpc":"2.0","id":1,"result":"0x13a4f20"}

缓存未命中时返回 -32004 No available Endpoint。这不表示 Key 或 Gateway 无效；请核对免 Endpoint 调用中的方法和参数，或继续配置 Endpoint。

4. 配置 Endpoint 获得完整方法访问

需要 Accelerator 范围外的方法、缓存未命中回源或写请求时：

  1. 在 Endpoints 添加与目标 Gateway 相同链、网络和协议的上游地址。
  2. 运行 Endpoint health check，确认地址和上游鉴权有效。
  3. 打开目标 Gateway，把 Endpoint 加入默认 JSON-RPC route。
  4. 选择按优先级故障切换，或按权重负载均衡。

配置完成后，用链页面推荐的方法确认 Endpoint 和网络，例如 EVM 的 eth_chainId。

上线检查清单

  • 通过目标链页面的网络验证方法确认没有选错网络。
  • 客户端能解析 HTTP 200 中的 JSON-RPC error，不能只判断 HTTP 状态码。
  • 遇到 Accelerator 未命中时有明确策略：接受 -32004，或配置 Endpoint 回源。
  • 遇到限流时读取 Retry-After，使用退避和抖动后重试。
  • 写请求不要自行重放；先了解路由与可靠性中的重试边界。
  • 不要把 API Key 写入源码、日志、错误上报或公开 URL。

下一步阅读免 Endpoint 调用、目标链与网络、鉴权与密钥和JSON-RPC。使用 TRON 原生 HTTP 接口时，阅读TRON HTTP API。

Last updated on
概览