49 lines
6.5 KiB
Markdown
49 lines
6.5 KiB
Markdown
# 伙伴云OpenAPI
|
||
|
||
## Docs
|
||
- 开发指南 [开发前必读](https://openapi.huoban.com/doc-661255.md):
|
||
- 开发指南 [申请 API Key](https://openapi.huoban.com/doc-661256.md):
|
||
- 开发指南 [基本概念介绍](https://openapi.huoban.com/doc-661257.md):
|
||
- 开发指南 [数据筛选器](https://openapi.huoban.com/doc-661258.md):
|
||
- 开发指南 [更新日志](https://openapi.huoban.com/doc-752983.md):
|
||
- 订阅 [订阅事件概述](https://openapi.huoban.com/doc-830149.md):
|
||
- 订阅 [Encrypt Key 加解密](https://openapi.huoban.com/doc-830150.md):
|
||
- 订阅 [订阅回调事件](https://openapi.huoban.com/doc-830151.md):
|
||
|
||
## API Docs
|
||
- 工作区 [获取工作区列表](https://openapi.huoban.com/api-17851166.md): 获取 API Key 授权范围内的企业工作区列表。
|
||
- 工作区 [获取工作区成员列表](https://openapi.huoban.com/api-17851167.md): 获取指定工作区内的成员列表。
|
||
- 表格数据 [获取表格列表](https://openapi.huoban.com/api-17851168.md): 获取指定工作区内的表格列表。
|
||
- 表格数据 [获取表格配置](https://openapi.huoban.com/api-17851169.md): 获取指定表格的详细字段配置。
|
||
- 表格数据 [查询数据列表](https://openapi.huoban.com/api-17851170.md): 获取指定表格的数据列表。
|
||
- 表格数据 [获取数据详情](https://openapi.huoban.com/api-17851171.md): 获取指定数据的数据详情。
|
||
- 表格数据 [创建数据](https://openapi.huoban.com/api-17851172.md): 在指定表格中创建新数据。
|
||
- 表格数据 [更新数据](https://openapi.huoban.com/api-17851173.md): 更新指定数据。
|
||
- 表格数据 [删除数据](https://openapi.huoban.com/api-17851174.md): 删除指定数据。
|
||
- 表格数据 [批量创建数据](https://openapi.huoban.com/api-47403602.md): 在指定表格中创建新数据，支持传入数据的数组做批量创建，单次最多批量创建 100 条数据。
|
||
- 表格数据 [批量更新或创建数据](https://openapi.huoban.com/api-72074325.md): 根据指定的依据字段，找到一条数据后，用其他字段更新数据，单次最多批量处理 100 条数据。
|
||
- 表格数据 [批量删除数据](https://openapi.huoban.com/api-75852335.md): 在指定表格中删除数据，支持根据传入的 item_ids 批量删除数据，单次最多批量删除 1000 条数据。
|
||
- 数据仓库数据 [获取数据仓库表格列表](https://openapi.huoban.com/api-27468361.md): 获取指定工作区内的数据仓库表格列表。
|
||
- 数据仓库数据 [获取数据仓库表格配置](https://openapi.huoban.com/api-27468358.md): 获取数据仓库中指定表格的详细字段配置。
|
||
- 数据仓库数据 [查询数据列表](https://openapi.huoban.com/api-27468364.md): 获取数据仓库中指定表格的数据列表。
|
||
- 数据仓库数据 [获取数据详情](https://openapi.huoban.com/api-27468360.md): 获取数据仓库中指定数据的数据详情。
|
||
- 数据仓库数据 [批量创建数据](https://openapi.huoban.com/api-27468359.md): 在数据仓库的指定表格中创建新数据，支持传入数据的数组做批量创建，单次最多批量创建 100 条数据。
|
||
- 数据仓库数据 [批量更新数据](https://openapi.huoban.com/api-27468365.md): 在数据仓库的指定表格中，根据指定的依据字段，找到一条数据后，用其他字段更新数据，单次最多批量处理 100 条数据。
|
||
- 数据仓库数据 [根据数据ID列表更新成相同数据](https://openapi.huoban.com/api-27468362.md): 在数据仓库的指定表格中更新数据，支持根据传入的 item_ids 批量更新成相同的 fields 字段值结果，只会更新 fields 结构中指定的字段，单次最多批量更新 1000 条数据。
|
||
- 数据仓库数据 [批量删除数据](https://openapi.huoban.com/api-27468363.md): 在数据仓库的指定表格中删除数据，支持根据传入的 item_ids 批量删除数据，单次最多批量删除 1000 条数据。
|
||
- 流程 [获取流程列表](https://openapi.huoban.com/api-288390793.md): 获取指定工作区内的流程列表。
|
||
- 流程 [查询流程实例列表](https://openapi.huoban.com/api-288430234.md): 查询指定范围内的流程实例列表，即用户发起的流程。
|
||
- 流程 [获取流程实例详情](https://openapi.huoban.com/api-289039041.md): 获取指定流程实例的详情。
|
||
- 流程 [获取流程实例的执行记录](https://openapi.huoban.com/api-289066739.md): 获取指定流程实例的执行记录。
|
||
- 流程 [查询流程任务列表](https://openapi.huoban.com/api-289138343.md): 查询指定范围内的流程任务列表，即用户执行的任务。
|
||
- 流程 [获取流程任务详情](https://openapi.huoban.com/api-289189688.md): 获取指定流程任务的详情。
|
||
- 文件 [批量获取文件详情](https://openapi.huoban.com/api-144471795.md): 用于获取文件详情，单次最多批量获取 100 个文件。
|
||
- 文件 [上传文件](https://openapi.huoban.com/api-17851175.md): 单文件上传，返回的文件ID需要放入字段中进行存储，无法单独使用。
|
||
- 订阅 [添加订阅](https://openapi.huoban.com/api-21987345.md): 可以对指定的一个表格订阅数据的创建、修改、删除事件，当数据发生订阅的数据变化后，会将数据内容推送到回调地址。
|
||
- 订阅 [取消订阅](https://openapi.huoban.com/api-21987343.md): 可以对指定的一个表格取消已经订阅的数据创建、修改、删除事件。
|
||
- 订阅 [获取订阅列表](https://openapi.huoban.com/api-21987344.md): 返回所有订阅的事件。
|
||
- 服务商 [获取 access_token](https://openapi.huoban.com/api-21987346.md): access_token 有效期为 2 小时，在此期间调用该接口 access_token 不会改变。当 access_token 有效期小于 30 分的时候，再次请求获取 access_token 的时候，会生成一个新的 access_token，与此同时老的 access_token 依然有效。
|
||
- 服务商 [获取服务商的 api_key](https://openapi.huoban.com/api-21987347.md): 服务商需要通过 access_token 来将客户的 api_key 换成服务商级别的 api_key，之后可正常代客户调用相关业务接口。
|
||
- 服务商 [获取服务商信息](https://openapi.huoban.com/api-21987341.md): 服务商需要通过 access_token 获取服务商的基本信息。
|
||
- 服务商 [设置订阅回调地址](https://openapi.huoban.com/api-21987342.md): 通过服务商的 access_token 获得的企业 api_key 进行事件订阅后，当订阅的表格数据发生增、删、改后，会回调服务商通过该接口设置的订阅回调地址。
|
||
- 服务商 [获取订阅回调地址](https://openapi.huoban.com/api-22648922.md): 获取服务商设置的回调地址 |