开发前必读

伙伴云提供企业级 API ，可以满足与企业内部系统的数据双向互通，或与第三方 SaaS 产品对接的定制化数据需求。

开发文档说明

企业级 API 首批开放了基础的数据能力接口，后续会继续开放诸如通讯录、流程、数据仓库、触发器等接口，开发者可以借此，实现企业服务与伙伴云的集成。支持的能力按功能进行归类，通过目录树可以快速查找，如工作区、表格、数据等。

建议先阅读一遍开发指南，以及如何获取调用接口的 API Key ，然后再独立查看各个功能接口的说明文档。

所有接口均需使用 HTTPS 协议、JSON 数据格式、UTF-8 编码。

接口调用流程

申请 API Key ，参考说明文档。

调用具体的能力接口，调用示例：

请根据您所访问的伙伴云的域名区分使用不同的接口地址

伙伴云的接口地址为：https://api.huoban.com

伙伴钉的接口地址为：https://api.huobanding.com

别名使用机制

伙伴云中的表格、字段都是以 ID 形式传递的，在程序开发中面对随机的 ID 不便于开发，因此提供了”别名“的方式来映射随机的 ID，这样可使开发的程序稳定，易理解。

在伙伴云系统中，表格设置菜单里进入”更多设置 → 资源别名“，即可为表格及字段的 ID 设置字符串”别名“。

在调用 OpenAPI 接口时，在 Header 中添加”X-Huoban-Return-Alias-Space-Id“代表启用别名模式，其值为工作区 ID，代表在给定的工作区下查找唯一的表格别名，表格别名格式为“T::{表格别名}”，字段别名格式为“F::{表格别名}.{字段别名}”。

调用接口时即可以别名替代原本要传递 ID 的参数，同时接口返回的数据结构中表格及字段 ID 也会以别名形式返回。

可以查看具体接口的参数，如注明“别名”，则代表该参数可以使用别名。目前表格数据的相关接口都已支持别名机制，数据仓库数据暂未支持。

请求示例：

返回示例：

{
  "code": 0,
  "message": "success",
  "data": {
    "item": {
      "item_id": "2300000000000001",
      "title": "abc",
      "fields": {
        "F::task.name": "abc"
      }
    }
  }
}

调用频率限制

出于系统保护的考虑，我们对调用 OpenAPI 的接口进行了一定的频率限制，当调用接口超过此限制时，会收到相应的错误码。

以下是底层的系统默认频率限制，伙伴云可能会根据运营情况调整此阈值：

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

在系统默认限制的同时，还会根据企业所购版本中包含的“API调用频次”来进行每分钟累计调用任意接口次数的上限控制，参考版本资源清单。

开发文档说明#

接口调用流程#

别名使用机制#

调用频率限制#

开发文档说明

接口调用流程

别名使用机制

调用频率限制