飞书平台配置指南
说明:本文主要介绍飞书平台连接器获取及设置、接口请求类型(POST, GET)、方案配置设置指南、适配器介绍。
一、连接器获取指南
1.1 应用连接器获取指南
文档地址:https://open.feishu.cn/document/server-docs/api-call-guide/server-api-list
1.1.1 在开放平台创建应用
链接地址:https://open.feishu.cn/app?lang=zh-CN
1.1.2 应用授权
根据调用接口获取对应权限信息,批量获取权限。
1.1.3 应用发版
应用授权之后,选择对应应用,进行版本发版。还需要通过审核。
参数说明:
二、方案配置指南
2.1 适配器介绍
- FSExecuteAdapter:写入适配器
- FSQueryAdapter:查询适配器
- FSApprovalExecuteAdapter:审批写入适配器
- FSApprovalQueryAdapter:审批查询适配器
- GetUserAdapter:通过部门查询用户信息
- FsSheetQueryAdapter:飞书表格查询适配器
2.2 查询方案配置示例
2.3 请求参数说明
2.3.1 path参数说明
在飞书的API中,有些参数需要放到请求地址path中。
示例:查询部门列表
2.3.2 query参数说明
参数是放到请求地址的query里面。
示例:用户查询
2.3.3 body参数说明
用于POST请求参数。大部分body参数是放到请求参数request里面。
2.4 方案配置说明
2.4.1 参数配置指南
query参数:放在请求参数request、其他请求参数otherRequest中。在生成队列时,会自动带上query关键字。
path参数:放在其他请求参数otherRequest中,且需要配置path关键字。
body参数:放在请求参数request中,一般在请求方法为POST、DELETE等才会有。如果此时还有query参数,需要配置到其他请求参数otherRequest里面。
配置示例:
{
"query": {
"page_size": "20",
"page_token": ""
},
"path": {
"department_id": "od-2a6fe844c6c51e8bc069815eaf72236f"
}
}
部门查询用户配置:如果是通过部门查询客户列表,请配置参数 dep_strategy
:部门方案ID。
部门审批配置:请查询链接 https://bbs.qeasy.cloud/d/12715-fei-shu-shen-pi-pei-zhi-jiao-cheng/2
- 飞书表格查询配置
飞书表格查询使用 FsSheetQueryAdapter
适配器,支持读取飞书电子表格数据。
API文档:https://open.feishu.cn/document/server-docs/docs/sheets-v1/spreadsheet-sheet/query
otherRequest参数配置表:
参数类型 | 参数名 | 说明 | 示例值 | 必填 |
path | spreadsheetToken | 表格的唯一标识符 | PZ2Asa69ZhClF9tzVUjcN8H1nV8 | ✓ |
path | range | 单元格范围 | 0ad5ec!B:I | ✓ |
headers_line | 标题所在行 | 是 | 1 | ✓ |
valueRenderOption 选项说明:
选项值 | 说明 | 用途 |
ToString | 返回格式化后的字符串 | 适用于显示用途 |
Formula | 返回公式 | 获取单元格公式 |
UnformattedValue | 返回原始值 | 获取原始数据值 |
dateTimeRenderOption 选项说明:
选项值 | 说明 | 示例 |
FormattedString | 格式化字符串 | 2024-01-01 10:30:00 |
SerialNumber | 序列号 | 45292.4375 |
配置示例:
{
"query": {
"valueRenderOption": "ToString",
"dateTimeRenderOption": "FormattedString"
},
"path": {
"spreadsheetToken": "PZ2Asa69ZhClF9tzVUjcN8H1nV8",
"range": "0ad5ec!B:I"
}
}
Range参数格式说明:
格式 | 说明 | 示例 |
sheetId!A1😃5 | 读取指定工作表的A1到D5单元格 | 0ad5ec!A1😃5 |
sheetId!A😃 | 读取指定工作表的A到D列 | 0ad5ec!A😃 |
sheetId!1:5 | 读取指定工作表的第1到5行 | 0ad5ec!1:5 |
sheetId!B:I | 读取指定工作表的B到I列 | 0ad5ec!B:I |
获取spreadsheetToken方法:
从飞书表格URL中提取,例如:
https://example.feishu.cn/sheets/PZ2Asa69ZhClF9tzVUjcN8H1nV8
其中 PZ2Asa69ZhClF9tzVUjcN8H1nV8
就是spreadsheetToken。