伙伴云OpenAPI
  1. 开发指南
伙伴云OpenAPI
  • 开发指南
    • 开发前必读
    • 申请 API Key
    • 基本概念介绍
    • 数据筛选器
    • 更新日志
  • 工作区
    • 获取工作区列表
      GET
    • 获取工作区成员列表
      POST
  • 表格数据
    • 表格
      • 获取表格列表
      • 获取表格配置
    • 数据
      • 查询数据列表
      • 获取数据详情
      • 创建数据
      • 更新数据
      • 删除数据
      • 批量创建数据
      • 批量更新或创建数据
      • 批量删除数据
  • 数据仓库数据
    • 表格
      • 获取数据仓库表格列表
      • 获取数据仓库表格配置
    • 数据
      • 查询数据列表
      • 获取数据详情
      • 创建数据
      • 更新数据
      • 根据数据ID列表更新成相同数据
      • 删除数据
  • 文件
    • 批量获取文件详情
      POST
    • 上传文件
      POST
  • 订阅
    • 订阅事件概述
    • Encrypt Key 加解密
    • 订阅回调事件
    • 添加订阅
      POST
    • 取消订阅
      POST
    • 获取订阅列表
      POST
  • 服务商
    • 获取 access_token
      POST
    • 获取服务商的 api_key
      POST
    • 获取服务商信息
      POST
    • 设置订阅回调地址
      POST
    • 获取订阅回调地址
      GET
  1. 开发指南

开发前必读

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

开发文档说明#

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

接口调用流程#

1.
申请 API Key ，参考 说明文档 。
2.
调用具体的能力接口，调用示例：
3.
请根据您所访问的伙伴云的域名区分使用不同的接口地址
伙伴云的接口地址为：https://api.huoban.com
伙伴钉的接口地址为：https://api.huobanding.com

调用频率限制#

出于系统保护的考虑，我们对调用 OpenAPI 的接口进行了一定的频率限制，当调用接口超过此限制时，会收到相应的错误码。
以下是底层的系统默认频率限制，伙伴云可能会根据运营情况调整此阈值：
单个 API Key 累计调用任意接口：10次/秒
在系统默认限制的同时，还会根据企业所购版本中包含的“API调用频次”来进行每分钟累计调用任意接口次数的上限控制，参考 版本资源清单 。
修改于 2025-01-16 03:17:04
下一页
申请 API Key
Built with