开放平台接口-查询成员列表
功能简介
系统的开放平台板块提供了很多接口,我们可以通过前端事件来接入开放平台接口,本文介绍在利用前端事件接入查询成员列表接口。
实现步骤
1 准备查询成员列表接口
管理员登录系统,进入[开放平台]>>[api]>>[通讯录体系]>>[成员]下,找到 查询成员列表 接口
【调用地址】:https://xxx.xxx.xxx/openapi/v1/user/user_list
域名填写当前站点域名
【请求方式】:POST
【返回类型】:JSON
【请求的Headers】:Authorization: Bearer 你自己的 api密钥(在api密钥下获取)
Authorization:Bearer 你自己的 api密钥
【请求参数】:无
【正常返回示例】:
{
"users": [
{
"user_id": "5c06e86f11f87c94fb1c24ee",
"name": "李四",
"account": "user_na3zfp52691",
"mobile": "18883241239",
"email": "9345332236@qq.com",
"category": "2",
"uniqueid": "12567",
"remark": "12月2日加入",
"title": "主管",
"departments": [
{
"dept_id": "5f0d7cf9f4361283774fcac4",
"name": "测试部"
}
],
"job_title": [
{
"dept_id": "51d1177b964603db9e60a962",
"job_title": "组长"
}
],
"roles": [
"525fb26fdcb1d02adda3dc6d",
"5ee8f9e0706af569e58b1cfa"
]
}
]
}
2 准备api密钥
管理员登录系统,进入[开放平台]>>[api密钥],创建带有通讯录接口权限的密钥。
3 表单设计
新建成员信息表单,设计字段:
字段名称 | 字段类型 |
---|---|
查询通讯录成员信息 | 扩展按钮 |
成员信息列表 | 子表单 |
姓名 | 子表单.单行文本 |
部门 | 子字段-单行文本 |
手机号 | 子字段-单行文本 |
邮箱 | 子字段-单行文本 |
4 前端事件配置
4.1 设置入口
表单设计页选择 [查询通讯录成员信息],在 [字段属性]>>[功能扩展设置],选择[前端事件],新建前端事件。
4.2 设置事件名称&说明
添加好前端事件后,首先设置前端事件的基础信息,即事件名称和事件说明,用于区分前端事件:
4.3 设置请求类型&URL
根据开放平台接口的介绍,可得到接口的请求类型和URL,我们可以按以下内容填入:
-
请求类型:POST
-
URL:https://xxx.xxx.xxx/openapi/v1/user/user_list
域名填写当前站点域名
4.4 Header/Body设置
Hearder:
Authorization:Bearer 你自己的 api密钥
此接口无请求参数,无需设置Body。
4.5 返回值格式&返回值设置
- 返回值格式选择 JSON
- 返回值设置页面,添加 「成员信息列表.姓名」、「成员信息列表.手机号」、「成员信息列表.邮箱」、「成员信息列表.部门」字段为其设置返回值:
「成员信息列表.姓名」:
$['users'][*]['name']
「成员信息列表.手机号」:
$['users'][*]['mobile']
「成员信息列表.邮箱」:
$['users'][*]['email']
「成员信息列表.部门」:
$['users'][*]['departments'][0]['name']
3.6 返回值错误判定
可不设置