说明:本文主要是介绍飞书平台连接器获取及设置、接口请求类型(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:应用发版:
应用授权之后,选择对应应用,进行版本发版。还需要通过审核。
参数说明:
host:飞书api接口地址。示例:https://open.feishu.cn
app_id:飞书应用的app_id
app_secret:飞书应用的secret.
二: 方案配置指南
2.1:适配器介绍
FSExecuteAdapter:写入适配器,
FSQueryAdapter:查询适配器,
FSApprovalExecuteAdapter:审批写入适配器
FSApprovalQueryAdapter:审批查询适配器
GetUserAdapter:通过部门查询用户信息
2.2:查询方案配置示例
示例方案:查询部门:https://pro.qliang.cloud/strategy/detail/72584096-2ee3-3494-8e00-fedf6255f98a#BasicSummary
用户查询:https://pro.qliang.cloud/strategy/detail/c5ebe075-99a4-3967-9242-6d2a8236c328#BasicSummary
审批示例:https://pro.qliang.cloud/strategy/detail/1b4b8cab-a906-3a82-a8d5-960a7c7a4abe#BasicSummary
2.3:请求参数说明
2.3.1:path参数说明:
在飞书的api有些参数需要放到请求地址path中(例如:查询部门列表https://open.feishu.cn/document/server-docs/contact-v3/department/children)里面的/open-apis/contact/v3/departments/:department_id/children里面的department_id是需要进行路径的替换。
2.3.2:query参数说明:
参数是放到请求地址的query里面(如:用户查询 https://open.feishu.cn/document/server-docs/contact-v3/user/find_by_department?appId=cli_a53a6fbf04e7500c)里面参数,department_id,page_size,page_token参数,是放到接口
/open-apis/contact/v3/users/find_by_department接口后面通过?带query参数里面。
2.3.3:body参数说明:
像post参数里面。大部分body是放到请求参数request里面。
2.4:方案配置说明
2.4.1 参数配置指南
1:query参数,放在请求参数request、其他请求参数otherRequest,在生成队列的时候,会自动带上query这个关键字。
2:path参数:放在其他请求参数otherRequest,且需要配置path关键字
3:body参数:放在请求参数request,一般在请求方法为post,delete等才会有。如果此时还有query参数,哪需要配置到其他请求参数otherRequest里面。
{
"query": {
"page_size": "20",
"page_token": ""
},
"path": {
"department_id": "od-2a6fe844c6c51e8bc069815eaf72236f"
}
}
4:如果是通过部门查询客户列表,请配置参数
dep_strategy:部门方案ID。
5:部门审批,请查询这个链接
https://bbs.qeasy.cloud/d/12715-fei-shu-shen-pi-pei-zhi-jiao-cheng/2