本文介绍如何通过飞书 API 读取飞书多维表的数据,从创建应用到发布,再到 API 调试。详细流程如下:
1、创建应用
2、申请权限,发布版本
3、创建多维表,并设置应用操作多维表的权限
4、查看接口文档,并调试 API
1、创建应用
打开飞书开放平台:https://open.feishu.cn/app
创建企业自建应用
根据提示填写名称和描述便可创建。
创建成功之后会有提示:应用发布后,当前配置方可生效。
在企业中,一般需要管理员审核。
2、申请权限,发布版本
发布版本,并不一定要开发什么内容,可以直接点击【版本管理与发布】>【创建版本】。
当然,如果是要用于飞书多维表的读写等操作,建议发布版本前,先申请下权限,然后一同创建版本发布。
在权限管理中的 API 权限下,搜索多维表,把需要的权限勾选上,第一个是读写的权限,第二个是只读。这里我选择第一个,注意第一个包含了第二个,所以申请第一个即可(可以打开所有权限进行比对~)。
开通之后提示待提交审核,接下来就去创建版本,提交审核。
点击【版本管理与发布】,这是右上角会有一个蓝色按钮【创建版本】,单击它,然后跳转到版本设置页面。
可以看到,需要填写版本号、更新说明,还可以看到变更内容,最后填写申请理由,保存,然后在跳出的确认弹窗点击【申请线上发布】。
接下来就是等待审批完成啦~
3、创建多维表,并设置应用操作多维表的权限
飞书多维表的入口,可以从飞书的官方平台进入:https://www.feishu.cn/
随便创建一个多维表,如下
我的连接是:https://xxxxxxxxxx.feishu.cn/base/PtRdbPjCFa5Og5sry0lcD1yPnKg?table=tblVBqxDbGXOJZPv&view=vewjgHC22S
创建好之后,需要给应用开通权限,否则,应用无法操作该飞书多维表。
在弹出的界面输入刚刚命名的应用名称进行搜索,然后选中刚刚创建的应用,配置编辑或管理权限,点击添加即可。
4、查看接口文档,并调试 API
官方查询多维表数据记录的 API 链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search
接口文档右边会有一个小型的调试台,可以边看边调试,当然也可以到 API 调试台操作,或者通过第三方工具,如 postman 等。
读取数据:
根据提示,把必填参数填上即可,上面我的飞书多维表的连接为:https://xxxxxxxxxx.feishu.cn/base/PtRdbPjCFa5Og5sry0lcD1yPnKg?table=tblVBqxDbGXOJZPv\&view=vewjgHC22S,其中 PtRdbPjCFa5Og5sry0lcD1yPnKg 就是 app_token,tblVBqxDbGXOJZPv 就是 table_id,vewjgHC22S 就是 view_id。
注意,使用 user_access_token 需要配置重定向链接,这里切换为 tenant_access_token,如果 token 过期,点击刷新即可。
填写表单的信息,可以只填必填的参数,然后点击开始调试。
在弹出的对话框中,点击调试。
调试结果:
正常获取到数据。。。
5、小结
本文详细介绍了通过飞书的开放 API 读取多维表的数据,整个过程如下:创建应用>申请权限>发布版本>创建多维表>设置多维表应用权限>查看接口文档>调试API获取数据。