流程概述
飞书开放平台提供的 API 遵循 RESTful 风格,请求 URL 的格式如下图所示。

快速入门
你可参考以下教程快速体验如何调用服务端 API:
流程概述
调用服务端 API 的流程和说明如下所示。

- 创建应用。在开发者后台,根据实际需求,创建自建应用或者商店应用。
Note 仅拥有 ISV 资质的用户可以创建商店应用。有关 ISV 的详细介绍,请参考如何入驻飞书开放平台。
获取访问凭证。飞书开放平台设置了多种访问凭证(也称为
access_token),不同的访问凭证代表了不同的资源访问权限。调用 API 时,必须在 HTTP Header 中携带访问凭证,以便获取权限范围内的资源信息。申请 API 权限。不同的 API 有不同的接口权限和字段权限要求。如需调用 API 则需先申请相匹配的 API 权限。如果涉及到访问敏感字段,还需申请访问敏感字段的权限。
(可选)配置应用数据权限。应用的数据权限是指以应用身份访问业务资源时可获取的数据范围。当应用申请了部分 API 的权限(例如,通讯录、飞书人事企业版)后,还需要配置相应的数据权限并提交审核。待审核通过后权限生效,才可以成功调用 API 获取数据。不在应用数据权限范围内的资源将无法成功获取到数据。
(可选)设置 IP 白名单。为了提升应用的安全性,可以为应用设置 IP 白名单。仅当发起请求的源 IP 在白名单内时,飞书开放平台才会响应,否则请求将被拒绝。
调用 API。当你根据实际需要完成以上配置步骤后,即可开始调用 API,API 的具体介绍与参数说明可以参考相应的 API 文档。飞书提供的全部开放能力参考API 列表。
