接入文档 - 百易API | 鉴权、CORS 与调试说明

快速开始

三步跑通第一个接口

打开 API 目录，按场景或 CORS 筛选，找到「免费可用」的接口。
进入详情页，阅读「接入说明」标签，复制 cURL 或示例代码，确认请求发往第三方提供方的 base URL。
在本地或服务器试调成功后，把 endpoint 接入项目，长期免费使用。

以目录收录的 0x API 为例，业务请求发往 api.0x.org，不要向 boyapi.com 发送 0x 业务请求：

cURL 示例

curl -G 'https://api.0x.org/swap/allowance-holder/price' \
    -H '0x-version: v2' \
    --data-urlencode 'chainId=1' \
    --data-urlencode 'sellToken=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2' \
    --data-urlencode 'buyToken=0x6b175474e89094c44da98b954eedeac495271d0f' \
    --data-urlencode 'sellAmount=1000000000000000000'

打开 API 目录查看 0x 详情示例

来源说明

所有收录接口都是「目录收录」

百易API 是一个收录公开免费接口的目录平台，本身不代理业务流量、不做站内自营产品。所有收录接口都由第三方公开来源提供，请按来源方公开的免费条款使用。

能力提供方：第三方公开 API（政府数据、开源项目、社区维护）。
免费能力：以来源方免费条款为准，配额、限流、商用许可请看来源方文档。
请求发往哪里：业务请求直连来源方 base URL（见详情页与 Agent 说明中的 full_url_example），不要发往 boyapi.com。

接入前先看详情页的「适用判断」，避免把 PoC 方案直接用于生产。

鉴权规则

以详情页标注为准

不同接口的鉴权方式不同，下列为常见类型，具体请求头与参数以详情页「接入说明」为准。

无需认证：直接按文档构造 URL 或请求体即可，注意来源方配额与 CORS。
AppKey / API Key：通过 Query、Header 或来源方控制台申请；勿将密钥写入前端或公开仓库。
AK/SK 签名：按来源方签名算法与时间戳规则构造请求。
OAuth：按来源方授权流程获取 token，再携带访问接口。

调用方式

请求发往来源方，不是 boyapi.com

请求地址：业务请求发往第三方 base_url（见详情页与 Agent 说明中的 full_url_example）。百易API 仅提供发现与文档，不代理业务流量。
协议格式：多为 REST/JSON；部分接口为 GraphQL 或见官方文档，详情页「协议格式」栏会标注。
示例代码：详情页会给出 cURL、JavaScript、Python 等示例，可直接复制后调整参数。

CORS 与代理

浏览器调用与生产部署

详情页会标注 CORS（Yes / No / Unknown）。若来源方未开放浏览器跨域，请通过服务端代理转发，不要把密钥放在前端。
目录收录接口：Agent 与自动化工具应读取详情页 #boyapi-agent-spec，向提供方域名发请求，而非 boyapi.com。
生产环境建议：固定出口 IP（若来源方要求）、合理超时与重试、记录 request id 便于与来源方对账。

调试方式

常见问题与排查顺序

确认请求 URL 是否指向正确的提供方（目录收录勿误打到 boyapi.com）。
核对鉴权：Key 是否有效、Header 名称是否与文档一致、签名是否过期。
看 HTTP 状态与响应体：401/403 多为鉴权；429 多为限流；4xx 多为参数；5xx 多为来源方或网络问题。
浏览器报 CORS 错误：改用服务端调用或查详情页 CORS 标注。
免费额度用尽或商用限制：查阅来源方条款。

详情页「接入说明」中的错误码表与 FAQ 可对照具体接口。

推荐试调

从发现到试调，再到接入项目