飞书 API 调用教程,图文讲解飞书接口的用法

调用飞书 API 的流程可以是:创建飞书应用、申请权限、获取访问凭证、设置 IP 白名单和调用服务端 API。飞书 API 在线地址为:https://feishu.apifox.cn/,这个在线地址的项目你可以克隆到 Apifox,以方便调试。

用 Apifox,节省研发团队的每一分钟

飞书 API 调用教程,图文讲解飞书接口的用法

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

调用飞书 API 的流程可以是:创建飞书应用、申请权限、获取访问凭证、设置 IP 白名单和调用服务端 API。飞书 API 在线地址为:https://feishu.apifox.cn/,这个在线地址的项目你可以克隆到 Apifox,以方便调试。下面将讲解飞书 API 如何调用,详情见下文。

创建飞书应用


首先,需要在飞书开发者后台创建一个应用:https://open.feishu.cn/app?lang=zh-CN

飞书创建应用
飞书创建应用


应用创建完毕,补全版本号方可生效:

补全版本号
补全版本号


成功之后,会收到“开发者小助手”发来的消息:

应用创建成功
应用创建成功

申请权限


如果要调用 API,需要先获取接口调用权限;如果涉及到访问敏感字段,还需获取访问敏感字段的权限。


在飞书开发者后台,点击相关的应用,然后定位到左侧栏的“权限管理”选项,即可开通相关的权限。

申请权限
申请权限

注意: 权限的申请应该遵循最小可用的原则。权限范围过大可能会威胁企业数据安全,导致应用无法通过审核。在无充分理由的情况下,请注意杜绝直接申请大量的接口权限。

获取访问凭证


当以上两步都操作完毕,即“应用创建及审核通过”和“权限配置”完毕后,即可开始调试飞书 API。飞书 API 的调试需要通过相关的访问凭证方可调用成功,所以需要先获取凭证。


因为是本教程的操作是自建应用,所以打开“开发者后台”后,选择相关的应用,然后点击左侧栏的“凭证与基础信息”即可看到当前的应用凭证。

飞书应用访问凭证
应用访问凭证


将应用凭证的 App ID 和 App Secret 复制下来,填入接口的 body 请求体中,即可获取到 access_token 凭证,如下图所示,这是在 Apifox 中的操作:

飞书获取 accrss_token 凭证
获取 API 调用凭证

添加 IP 白名单

为了提高应用访问的安全性,开发者可以通过 IP 白名单功能设置能够合法访问飞书服务端 API 的 IP 列表,不在白名单列表中的 IP 地址的请求会被拒绝,并返回错误提示信息。


在 Windows 系统上,使用快捷键 Win+R,然后输入 cmd 按回车,输入 ipconfig,即可看到当前系统的 ip 地址:

查看系统 ip 地址
查看系统 ip 地址

然后在飞书开发者后台,选择一个应用后,点击左侧的“安全设置”,即可填写 IP 白名单。

设置白名单
设置白名单

开始调用飞书 API


开通“通过手机号或邮箱获取用户 ID”的权限:

飞书获取用户 ID
开启权限

然后在 Apifox 中,填写你的手机号或者邮箱,即可获得 user_id

飞书获取用户的 user_id
获取用户的 user_id

有了 user_id 后,就可获取单个用户信息,如下图所示:

获取用户的信息
获取用户的信息


其它操作也是类似,要使用某个功能,一般是先获取凭证和相关的参数,然后即可调用。

知识扩展: