2022-05-12 更新:企业「接口授权」1期上线

为了给企业提供稳定、易用的数据接口能力,伙伴云在 5.0 新版中提供了企业级「接口授权」管理和全新的 OpenAPI 。可以满足与企业内部系统的数据双向互通,或与第三方 SaaS 产品对接的定制化数据需求。

新版体验:https://app.huoban.com/v5

接口文档:https://openapi.huoban.com/

企业级「接口授权」

申请 API Key 是调用伙伴云 API 接口的第一步,相当于创建了一个访问凭证,调用 API 接口时都需要通过 API Key 来鉴别调用者身份,以及可以调用的数据范围。

仅当前拥有有效付费版本的企业,可创建 API Key,可进入企业后台的“企业账户”查询

创建 API Key

bd3025851cd38bef6dd5d3be50fb223f.png

1、从企业空间左下角进入“企业设置 → 企业后台”(需要为企业管理员)。
2、在企业后台进入“接口授权”,点击“创建 API Key”即可,每个企业最多可创建 50 个。
3、可点击已创建的 API Key,在右侧栏中为其添加“备注”,用来记录每个 API Key 的用途。

API Key 的安全设置 -- 授权范围

API Key 创建后,默认授权可以调用企业下“全部工作区”内的数据,可以通过修改“授权范围”来授权只可以调用部分工作区下的数据,以此来保证不同用途的 API Key 可以有不同的授权范围,保证数据安全。

643602ce9294a6dc69691d9495c9b01e.gif

API Key 的安全设置 -- 可信 IP(敬请期待)

API Key 创建后,默认可以被任意 IP 地址进行使用,可以通过设置“可信 IP”来限定仅在指定的 IP 地址下可以调用,用来防止 API Key 泄露而导致的数据外泄风险,保证数据安全。

API Key 的安全设置 -- 更换 API Key

如发现 API Key 已经泄露,可以立即“更换 API Key”,更换后只会重新分配 API Key ,之前设置的授权范围、可信 IP、备注等都会保留。

OpenAPI

接口文档

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

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

调用频率限制

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

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

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

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

2023-03-10 更新
1024 次查看
0