开发者快速开始

快速开始

1. 注册账号

注册需要用户名、显示名、邮箱和密码，并通过邮箱验证码与图形验证码完成。注册不需要提供任何支付信息。

注册 →

2. 复制你的 API token

每个账号会签发一个 API token。位置在「账号 → 安全 → Token 管理」，可在那里显示并复制。目前没有自助轮换：若你认为 token 已泄露，请联系我们重新签发。

打开账号 → 安全 →

3. 充值余额

调用先充后用、按次计量。每个接口在其详情页公布各自的单价。余额不足时网关返回 402，且该调用不会被转发给上游。

查看价格 →

4. 发起第一次调用

把 hub slug、路由与标识符替换成你要调用的那个接口的值。每个接口详情页都会为你生成这段代码，支持 19 种语言，并已填入该接口自己的路由与参数。

curl --request GET \
  --url 'https://www.apipull.com/gateway/v1/{hub-slug}/curp/query_by_curp?curp=GO**************03' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Token: {YOUR_API_TOKEN}'

下面的标识符是脱敏后的示例，不是可用值。请替换为你具备合法依据查询的标识符。

鉴权

鉴权只需一个请求头。没有 OAuth 流程，没有签名，也不使用 Authorization 头。

项	值
请求头名称	`X-Api-Token`
作用范围	每账号一个 token，对余额可支付的所有接口均有效
轮换	需联系我们办理——暂无自助重新生成

请求格式

所有接口都在同一个网关域名之后。路径由该 API 的 hub slug 加上接口详情页展示的路由组成。

基础 URL	`https://www.apipull.com/gateway/v1/{hub-slug}{route}`
请求方法	多数接口是带 query 参数的 GET；少数是带 JSON 请求体的 POST，具体见接口详情页。
Content-Type	带请求体时为 application/json

响应格式

响应由持有记录的机构原样透传，因此不同接口的载荷结构并不一致。有的把记录包在 data / status / message / success 里，有的把被查询的标识符放在顶层。请始终阅读具体接口页的「响应」一节，不要假定存在统一的外层结构。

示例——CURP 校验接口的响应：

{
  "data": {
    "statusCurp": "RCN"
  },
  "status": 200,
  "message": "Found",
  "success": true
}

限制与计费

速率限制与免费额度按接口配置，并在各接口详情页公布，请到你要调用的那个接口页查看。

限流按接口生效；具体数值见接口页的「速率限制与免费额度」一节。
未命中记录的调用在每个接口的每日免费额度内不计费。超出额度后，空结果按单价计费。
扣费发生在调用当时。没有月度承诺，也没有起步量。
企业限额与任何服务等级承诺，仅在另行签署的协议中约定时才存在。

错误处理

以下是生产流量中实际观测到的状态码。未列出的状态码尚未出现过。

状态码	含义与处理方式
`200`	请求已到达上游并有响应返回。其中包含“查无记录”的情形，因此要看载荷内容，不能只看状态码。
`402`	预付余额不足以支付本次调用。调用未发起，也未扣费。充值后重试。
`504`	上游未在时限内响应。请稍后重试；对慢速登记机构而言这是正常的失败形态。
`404`	路由不存在，或该接口已下线。
`401`	API token 缺失或无效。

延迟预期

响应时间主要由上游机构决定，而非我们的网关。2026-03-25 至 2026-09-22 之间全部 534 次生产调用中，平均响应时间为 10.0 秒，74.9% 返回了实质业务结果。个别接口明显慢于均值。

按慢响应来设计

不要把对我们的同步调用放在有用户等待且无兜底的请求链路上。
客户端超时至少设为 30 秒，并把超时当作「未知」而不是「否」。
流程允许时，把任务入队并以异步方式通知用户。

以上数字由我们自己的调用日志全量聚合，未抽样。含上游机构与留存范围的完整口径见数据来源与使用说明页。数据来源与使用说明 →