伙伴云OpenAPI
Powered by Apifox

开发前必读

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


开发文档说明#

  • 企业级 API 首批开放了基础的数据能力接口，后续会继续开放诸如通讯录、流程、数据仓库、触发器等接口，开发者可以借此，实现企业服务与伙伴云的集成。支持的能力按功能进行归类，通过目录树可以快速查找，如工作区、表格、数据等。
  • 建议先阅读一遍开发指南，以及如何获取调用接口的 API Key ，然后再独立查看各个功能接口的说明文档。
  • 所有接口均需使用 HTTPS 协议、JSON 数据格式、UTF-8 编码。

接口调用流程#

  1. 申请 API Key ，参考 说明文档 。
  2. 调用具体的能力接口，调用示例：
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"'

调用频率限制#

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

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

  • 单个 API Key 累计调用任意接口：300次/分钟

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