开放性应用实践概览
亿联UC提供了服务端API开放和客户端SDK开放,开发者基于自己的应用场景可以灵活地集成亿联UC的开放性接口。
本章介绍了亿联UC最常见的3个典型集成场景,帮助各位开发者们了解典型场景下的集成方案。
表1 最佳实践概览
实践 | 应用场景 |
---|---|
实践1:UC应用免登集成 | 实现一键免登跳转,并且支持同时对接多个应用 。满足用户侧使用ume客户端时,可进行多个办公应用一键免登跳转,有效提高用户办公效率。 |
实践2:发送带图片的卡片消息 | 可满足环境中存在如机房温控系统、网络监控系统、OA系统等,运维管理人员在日常工作时,需实时确认各个系统是否运行正常,当有告警时,需实时收到消息,或针对OA系统当生成新审批单时,消息通知到对应审批人。 |
实践3:预约视频会议 | 通过API预约一场在线会议,可自定义预添加参会成员,预约成功后将生成会议,对应参会用户的客户端上将收到会议日程,用户可自行使用UME客户端加入会议。 |
一、最佳实践1:UC应用免登集成
1、流程概述
1.在应用管理的web端,添加应用,获取client_id与security。注意:创建应用后,需开启应用免登。
2.在PC端(或移动端)的工作台中,点击应用的图标,将会自动跳转访问应用中配置好的首页地址,同时也将获取到UC针对该次点击跳转所生成的code授权码(使用一次即失效,若不使用则有效期5分钟),该授权码自动拼接在跳转的网页地址的末尾,传递给第三方应用服务器。
3.第三方应用后端拿到code后,调用“获取token”接口,获取到token作为后续接口调用的身份凭证。
4.将身份凭证token作为接口请求的一个标头Header参数,调用“用户鉴权”接口,即可获取到当前点击跳转应用的用户账号信息。
5.UC用户信息与第三方系统的用户信息中的某个字段参数匹配上,第三方系统允许对应账号参数匹配成功后自动通过登录,即可登录到对应的账号。从而实现跳转免登对接。
2、流程图
3、配置步骤细化
示例步骤如下
1)UC侧配置:
1、登录UC企业管理平台- - 应用管理- -添加应用- -保存。
2、创建成功,点击确认,编辑应用。
3、填写主页跳转地址(第三方系统网页的地址,地址可以直接拼接添加后缀)、启用应用免登,保存。
4、查看应用凭证中的ID和secret。
5、启用并发布应用,可自定义发布范围或发布给所有人。
6、登录ume客户端(账号需在应用发布范围内),可在工作台看到已创建的应用。
7、点击应用,将自动跳转到对应主页跳转地址的网页,可在跳转后的浏览器网页地址上看到code的值。
2)第三方系统执行部分(使用postman调用UC服务端接口,代为模拟)
1、打开postman,打开最佳实践- - 单点登录- -“获取token(单点登录场景验证使用)”接口,将code参数写入
body中对应位置,同时body中redirect_uri需和创建应用时的主页跳转地址保持一致。
2、打开postman环境模板配置,点击edit编辑当前环境参数,找到AccessKey ID和AccessKey Secret,对应填写为UC侧配置中的第4点所获取到的ID和secret。
3、点击send,发送“获取token(单点登录场景验证使用)”接口请求,获取到token。
4、点击“查询登录用户详情”接口,send发送请求,即可获取到对应点击跳转的ume用户的用户详情信息。
5、第三方系统根据获取到的用户详情信息,自行判断取哪个参数值作为比对值,与其自身的账号体系进行比对,并允许对应账号自动登录。至此,实现了应用集成单点登录。
二、最佳实践2:发送带图片的卡片消息
1、流程图
2、调用步骤细化
示例步骤如下
1)UC侧配置
1、登录UC企业管理平台- - 应用管理- -添加应用- -保存。
2、创建成功,点击确认,编辑应用。
3、启用“机器人”,保存。
4、查看应用凭证中的ID和secret。
5、启用并发布应用,可自定义发布范围或发布给所有人。
6、登录ume客户端(账号需在应用发布范围内),等待第三方系统调用接口发送IM消息。
2)第三方系统调用UC接口执行发送IM消息(使用postman调用UC服务端接口,代为模拟)
1、打开Postman软件中的环境模板配置,点击edit编辑当前环境参数,找到AccessKey ID和AccessKey Secret,对应填写为上述第4点获取到的ID和secret。
2、打开“获取token(发送IM消息验证使用)”接口,点击send,发送请求,获取到token。
3、打开“查询用户列表(获取要接收消息的用户Id)“接口,点击send,发送请求,获取到用户列表,从中自行选择一个用户,获取其”id”
用途:主要用于确定接收IM消息的成员id。
4、打开“预签上传(获取上传地址链接和fileId)”接口,在body中,填写“fileName”的值
(需和要上传的图片名称一致)和“fileSize”的值(需和要上传的图片大小一致,单位:字节,获取方法:右键图片--属性--大小,就是作为fileSize的值),Send发送请求,即可获取到UC返回的一串url(即上传地址)和fileId。
5、打开“预签上传(上传本地图片至UC)”接口,将上一步获取到的url值粘贴进请求地址框中,在
Body中点击使用binary,再点击select file,选择电脑中的图片。Send发送请求,响应返回1,即成功完成图片上
传到UC服务器的操作。
6、打开“发送卡片消息(跳转百度界面卡片消息)”接口,在body中,将“imageId”的值写为上述第4步获取到的fileId值,将“receiverId”的值填写为上述第3步获取的接收消息的成员对应的 “id” 。Send发送请求,即可在登录了对应账号的ume客户端上接收到带图片的卡片消息。
三、最佳实践3:预约视频会议
1、调用流程:
1)获取token后,发送添加会议请求,会议号生成成功;
2)UC将根据已配置好事件订阅地址,自动推送会议添加成功的事件;
tips:若您有获取webhook事件的需求,详情可查看服务端API参考中的事件订阅配置方法。