伙伴云 OpenAPI 完整文档

开发指南

1. 基础信息

伙伴云提供企业级 API，满足与企业内部系统的数据双向互通，或与第三方 SaaS 产品对接的定制化数据需求。所有接口均需使用 HTTPS 协议、JSON 数据格式、UTF-8 编码。

接口地址

伙伴云：https://api.huoban.com

伙伴钉：https://api.huobanding.com

调用频率限制

单个 API Key 累计调用任意接口：10次/秒

同时根据企业所购版本中包含的"API调用频次"进行每分钟累计调用次数上限控制。

2. 鉴权方式

通过在 HTTP Header 中添加 Open-Authorization: Bearer {API_KEY} 进行鉴权。

curl --location --request POST 'https://api.huoban.com/openapi/v1/table/list' \
--header 'Content-Type: application/json' \
--header 'Open-Authorization: Bearer AbCd1EfGh2IjKl3MnOp4QrSt5UvWx6Yz' \
--form 'space_id="123456"'

3. 别名使用机制

伙伴云中的表格、字段都是以 ID 形式传递的，提供了"别名"的方式来映射随机的 ID：

在 Header 中添加 X-Huoban-Return-Alias-Space-Id（值为工作区ID）启用别名模式
表格别名格式：T::{表格别名}
字段别名格式：F::{表格别名}.{字段别名}
目前表格数据相关接口均支持别名，数据仓库数据暂未支持

工作区

GET 获取工作区列表

yaml

接口地址：https://openapi.huoban.com/api-17851166

POST 获取工作区成员列表

yaml

接口地址：https://openapi.huoban.com/api-17851167

表格数据

POST 获取表格列表

yaml

接口地址：https://openapi.huoban.com/api-17851168

POST 获取表格配置

yaml

接口地址：https://openapi.huoban.com/api-17851169

POST 查询数据列表

yaml

接口地址：https://openapi.huoban.com/api-17851170

POST 获取数据详情

yaml

接口地址：https://openapi.huoban.com/api-17851171

POST 创建数据

yaml

接口地址：https://openapi.huoban.com/api-17851172

PUT 更新数据

yaml

接口地址：https://openapi.huoban.com/api-17851173

DELETE 删除数据

yaml

接口地址：https://openapi.huoban.com/api-17851174

POST 批量创建数据

yaml

接口地址：https://openapi.huoban.com/api-47403602

PUT 批量更新或创建数据

yaml

接口地址：https://openapi.huoban.com/api-72074325

DELETE 批量删除数据

yaml

接口地址：https://openapi.huoban.com/api-75852335

数据仓库数据

POST 获取数据仓库表格列表

yaml

接口地址：https://openapi.huoban.com/api-27468361

POST 获取数据仓库表格配置

yaml

接口地址：https://openapi.huoban.com/api-27468358

POST 查询数据列表

yaml

接口地址：https://openapi.huoban.com/api-27468364

POST 获取数据详情

yaml

接口地址：https://openapi.huoban.com/api-27468360

POST 批量创建数据

yaml

接口地址：https://openapi.huoban.com/api-27468359

PUT 批量更新数据

yaml

接口地址：https://openapi.huoban.com/api-27468365

PUT 根据数据ID列表更新成相同数据

yaml

接口地址：https://openapi.huoban.com/api-27468362

DELETE 批量删除数据

yaml

接口地址：https://openapi.huoban.com/api-27468363

流程

GET 获取流程列表

yaml

接口地址：https://openapi.huoban.com/api-288390793

GET 查询流程实例列表

yaml

接口地址：https://openapi.huoban.com/api-288430234

GET 获取流程实例详情

yaml

接口地址：https://openapi.huoban.com/api-289039041

GET 获取流程实例的执行记录

yaml

接口地址：https://openapi.huoban.com/api-289066739

GET 查询流程任务列表

yaml

接口地址：https://openapi.huoban.com/api-289138343

GET 获取流程任务详情

yaml

接口地址：https://openapi.huoban.com/api-289189688

文件

POST 批量获取文件详情

yaml

接口地址：https://openapi.huoban.com/api-144471795

POST 上传文件

yaml

接口地址：https://openapi.huoban.com/api-17851175

服务商

POST 获取 access_token

yaml

接口地址：https://openapi.huoban.com/api-21987346

POST 获取服务商的 api_key

yaml

接口地址：https://openapi.huoban.com/api-21987347

GET 获取服务商信息

yaml

接口地址：https://openapi.huoban.com/api-21987341

POST 设置订阅回调地址

yaml

接口地址：https://openapi.huoban.com/api-21987342

GET 获取订阅回调地址

yaml

接口地址：https://openapi.huoban.com/api-22648922

数据模型

通用模型

分类	模型名称
Space	工作区、封面
Table > Config	text 文本、date 日期、category 选项、user 用户、relation 关联、signature 签名、file 文件、location 位置、numeric 数字
Table	字段配置、字段列表、表格配置、表格、数据仓库表格配置
Item > Field	signature 签名、location 位置、file 文件、text 文本、numeric 数字、date 日期、category 选项、user 用户、relation 关联
Item	数据、字段值、字段提交
Filter > Query	Eqm, Eq, Ne, Gt, Gte, Lt, Lte, In, Ain, Nin, Inc, Em
Filter > Connector	And, Or
Filter	Filter, Query, Condition, Connector
Object	用户、备选项、位置、文件、签名
Procedure	流程、流程实例、流程执行记录、流程任务

业务模型

模型名称
订阅、回调信息、服务商信息、企业信息、异常报错、全局返回