搜索 API
正在加载…
REST API · JSON

几分钟,发起第一个请求。

先浏览接口文档与响应示例;准备调用时登录账户,复制你的 API Key 并订阅需要的数据。

快速开始

以下示例使用 Amazon 商品详情接口。请先订阅 Amazon 数据(可领取 Free 计划);其他数据的参数可在各自接口文档中查看。

先在本机环境变量 ZOXDATA_API_KEY 中设置 Amazon 产品的 Key,再运行下面的命令。示例地址自动使用当前站点域名;请只在自己的终端执行,妥善保管 Key。

curl "https://api.zoxdata.com/reddit/v1/subreddit?subreddit=python" \
  -H "x-api-key: $ZOX_KEY"

身份认证

调用请求通过 X-API-Key 认证。每个账号一把 Key,可调用你订阅的全部数据;Key 可在控制台查看或重新生成。

控制台使用会话 Cookie 与 CSRF token;API Key 与控制台会话分别管理,退出登录不会撤销已创建的 Key。

状态与用量

200
成功;扣减 1 次订阅请求数。
202
处理中;保留 1 次额度。通过 GET /v1/requests/请求编号 查询,使用同账户同产品的有效 Key。
401 / 403
认证失败或未订阅该数据;检查 Key 是否为当前有效的 Key,以及是否已订阅。
409
未订阅、次数用完或操作不可用;查看错误 code。
410
成功结果已超过 24 小时保留期;原请求不会重新执行。
429
达到请求频率或处理中数量限制;根据 Retry-After 等待。
502
响应含 data.status=failed 时,调用已失败并退回预留次数;网络故障时可用 request_id 查询原请求结果。

遇到异常时保留响应的 X-Request-Id,便于定位。在控制台查看调用量、错误率与响应耗时的汇总统计。

接口与示例

产品目录包含各站点接口、参数和响应示例。在线调试使用数据库中的示例数据,不会向原站发起采集。

尚未接真实采集、邮件、支付或正式套餐。可在参数中加入 scenario: "failure" 或 "delayed",验证失败释放、异步查询及后台恢复。