认证 - Pubrio Documentation

API 密钥

进行认证时，需要在请求头中包含 pubrio-api-key。该请求头应填写您的 API 密钥，例如 a1b2c3d4e5f6g7h8，这代表您的 API 密钥。

pubrio-api-key: a1b2c3d4e5f6g7h8

您需要创建 API 密钥以访问 Pubrio API。要创建 API 密钥，请前往设置页面进行操作。

API 密钥已包含您的工作区（Profile）信息，因此您无需在请求体中传递 profile_id。profile_id 参数仍然可用以保持向后兼容性，但不再是必填项。

请求头

除 pubrio-api-key 外，请同时发送用于标识你的客户端的 User-Agent 请求头。

pubrio-api-key: a1b2c3d4e5f6g7h8
Content-Type: application/json
User-Agent: my-app/1.0

缺失或过于通用的 User-Agent 会在请求到达 API 之前被拒绝。 不带可识别 user agent 的请求会在边缘节点被拦截，返回 HTTP 403 及纯文本内容 error code: 1010 —— 它不是 JSON，也不属于已记录的错误码。这看起来像认证失败，但实际并非如此：你的 API 密钥没有问题。常见 HTTP 库的默认 user agent 会受影响 —— Python 的 urllib（Python-urllib/3.x）会被拦截，而 curl 与 requests 不会。若遇到 error code: 1010，请显式设置 User-Agent 后重试。