Skip to main content
通过开放接口，您可以获取或更新任务信息、控制云采集、读取采集到的数据等。在此之前，您应该拥有一个八爪鱼的账号。

​
认证方式

除获取和刷新 Access Token 的接口外，业务接口支持以下任一认证方式。每个请求只需选择一种，不要同时传入两种凭据。

​
API Key

在请求头中传入 API Key：
API Key 与 MCP 使用同一套密钥：登录八爪鱼官网后，在账户中心创建。具体步骤见 获取 API Key。使用 API Key 时不要写成 Authorization: Bearer op_sk_xxxxxx。
在 OpenAPI 交互式界面中，选择或填写 API Key（x-api-key） 授权后即可试用接口；请勿把真实 Key 写入示例、截图、公开代码或日志。

​
Access Token

已有集成仍可继续使用 Authorization: Bearer <access_token>。获取和刷新方式见 认证。

​
联系方式

​
URI 规范

我们提供的开放接口都应该基于如下 URL 访问： BaseURL: https://openapi.bazhuayu.com 例如：【搜索任务】的完整访问地址应该是 GET https://openapi.bazhuayu.com/task/search?taskGroupId={taskGroupId}
注意：对于本文档出现的 {xxxx}，它表示占位符，你需要用实际真实的值来替换它。如上文中的 taskGroupId={taskGroupId}，你需要用真实的 taskGroupId 替换 {taskGroupId}。

​
接口说明

为了更稳定地使用我们的服务，建议接口访问频率不超过 20 次/秒，如果超出该频率将会返回 429 的状态码，此时请降低访问频率到 20 次/秒以下或者更低。频率限制是通过 IP 限制，可以用多个不同的 IP 访问来提高访问效率。 以下接口正常情况下返回的状态码为 200，若返回非 200 状态码请移步页尾查看错误码来尝试解决问题。

​
权限描述

更多的功能请升级账户。

​
遇到问题

文档中的任意接口将会返回 requestId，如您调用接口发现任何错误或者结果不符合预期，请提供该值以供我们工作人员能够更加快速为您排查。