> ## Documentation Index
> Fetch the complete documentation index at: https://www.bazhuayu.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 八爪鱼 开放接口文档

> 八爪鱼开放API文档 — 涵盖认证、任务管理、云端采集及数据获取。

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

## 联系方式

* 联系人：八爪鱼技术支持
* 邮箱：[help@skieer.com](mailto:help@skieer.com)

## 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 状态码请移步页尾查看错误码来尝试解决问题。

## 权限描述

| 服务     | 接口           | 权限              |
| ------ | ------------ | --------------- |
| 接口调用凭证 | 获取全新Token    | 全部              |
| 接口调用凭证 | 刷新Token      | 全部              |
| 任务组    | 获取用户的任务组信息   | 旗舰版、旗舰+、企业版、团队版 |
| 任务     | 搜索任务         | 旗舰版、旗舰+、企业版、团队版 |
| 任务     | 批量获取任务步骤信息   | 旗舰+、企业版、团队版     |
| 任务     | 更新任务步骤流程字段值  | 旗舰+、企业版、团队版     |
| 任务     | 复制任务         | 旗舰+、企业版、团队版     |
| 任务     | 移动任务到指定组     | 旗舰+、企业版、团队版     |
| 云采集    | 启动云采集        | 旗舰+、企业版、团队版     |
| 云采集    | 停止云采集        | 旗舰+、企业版、团队版     |
| 云采集    | 批量获取任务状态     | 旗舰+、企业版、团队版     |
| 云采集    | 批量获取任务状态V2   | 旗舰+、企业版、团队版     |
| 任务分析   | 查询任务采集与执行分析  | 旗舰版、旗舰+、企业版     |
| 数据     | 获取未导出数据      | 旗舰版、旗舰+、企业版、团队版 |
| 数据     | 确认数据已导出      | 旗舰版、旗舰+、企业版、团队版 |
| 数据     | 根据指定位置获取任务数据 | 旗舰版、旗舰+、企业版、团队版 |
| 数据     | 清空任务数据       | 旗舰版、旗舰+、企业版、团队版 |

更多的功能请升级账户。

## 遇到问题

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