连接器
功能简介
连接器指触发事件和业务执行的集合,包含了若干触发事件和执行动作,可以实现异构系统之间的互联互通。主要包括四大类:自建连接器、官方连接器、三方连接器、系统内置连接器。
自建连接器:由你在智慧空间服务平台自行创建,并需要自行配置鉴权方式、触发事件与执行动作等。
官方连接器:由厂商提供,无需配置直接可用。
三方连接器:由第三方平台所开放的接口封装而成。你可以在系统配置中查阅。
系统内置连接器:系统内置的基础连接器,如:同步回调。
连接流能够将各连接器通过零代码方式互联在一起,形成完整的事件流,如:当连接器A同步触发某事件,连接器B将执行某动作。
创建自建连接器
登录智慧空间服务平台。
点击 系统集成 > 系统连接器。
点击创建连接器。
输入连接器的名称与描述,点击保存。
编辑连接器信息。
基本信息
编辑连接器的名称与描述。
鉴权设置
鉴权用于校验用户是否有权限访问接口,连接器内的所有执行动作共用这套鉴权设置,用户完成鉴权才可调用该连接器的执行动作。
第一步:设选择鉴权方式
无鉴权:用户无需进行鉴权。
Token鉴权:自定义Token鉴权方式。
自定义签名:自定义签名鉴权方式。
使用已有鉴权:若已有第三方平台提供的鉴权方式,可直接使用。
域名变量:开启后将设置接口域名为环境变量。若为不同客户提供服务的域名不相同时,可开启本开关,开启后域名由客户自行配置。
说明
若使用已有鉴权,则无需进行下述鉴权设置。
设置鉴权字段:自定义对应的鉴权字段,可在下方预览用户的鉴权界面。
若选择Token鉴权方式:
第二步:设置token请求接口
设置Token请求接口:支持使用自定义域名和连接器模板域名,只有在配置了连接器域名模板时才可以使用连接器模板域名,可选:GET / POST / PATCH / PUT / DELETE。
设置Token请求参数:设置获取Token所需参数在HTTP请求中的位置。
Token 有效期:设置Token 有效期。
Token 失效判断:判断Token是否失效,若失效,将请求新的Token。
第三步:设置鉴权请求参数
设置鉴权请求参数:设置接口请求时需要携带的鉴权参数,例如钉钉开放网关需要在http请求头中携带参数x-acs-dingtalk-access-token,参数值取上一步token请求接口返回的token,则这里在HTTP请求头中配置key:x-acs-dingtalk-access-token,value:$.token.accessToken。
第四步:鉴权调试
点击保存并调试,模拟用户在前端进行的账号授权操作,确保您的账号授权配置可用。你可以自行检查返回结果是否符合预期。
若选择自定义签名鉴权方式:
第二步:设置鉴权请求参数
设置鉴权请求参数:设置接口请求时需要携带的鉴权参数,例如钉钉开放网关需要在http请求头中携带参数x-acs-dingtalk-access-token,参数值取上一步token请求接口返回的token,则这里在HTTP请求头中配置key:x-acs-dingtalk-access-token,value:$.token.accessToken。
第三步:鉴权调试
点击保存并调试,模拟用户在前端进行的账号授权操作,确保您的账号授权配置可用。你可以自行检查返回结果是否符合预期。
触发事件
触发事件用于外部系统向系统推送数据。
点击创建触发事件。
编辑事件基础信息,点击下一步。
配置出/入参数模型,可选参数类型为:object / string / number / array / boolen。
执行动作
定义被其它系统连接的能力,例如提供接口来提供系统的数据或者消费其它系统推送过来的数据。
点击创建执行动作。
编辑执行动作基本信息,点击下一步。
按照格式进行HTTP设置、API入参及API出参设置。
进行调试,你可以自行检查返回结果是否符合预期。
点击发布。
鉴权凭证
根据你的鉴权设置按需填写鉴权凭证。
管理自建连接器
登录智慧空间服务平台。
点击 系统集成 > 系统连接器。
点击任一连接器右侧设置,修改连接器配置。
点击任一连接器右侧删除,将连接器删除。
连接流
连接流能够将各连接器通过零代码方式互联在一起,形成完整的事件流,如:当连接器A同步触发某事件,连接器B将执行某动作。
前提条件
你已创建并配置好相关连接器。更多信息,请参阅:连接器。
创建连接流
登录智慧空间服务平台。
点击 系统集成 > 系统连接器。
点击我的连接流。
点击创建连接流。
配置流程。
说明
在界面右侧按照步骤配置,在界面左侧选择对应的模块,并能够总览整个事件流程。
在左侧界面点击触发事件,配置连接器及其触发事件。a.选择连接器。b. 选择连接器对应的触发事件。
c. 查看参数配置。出参/入参数据由对应连接器配置,你可以进行查看确认。
异步触发事件:事件的执行是非阻塞的,即一个事件的触发不会等待该事件完成,而是立即继续执行后续的代码。
同步触发事件:事件的执行是按照严格的顺序进行的。当一个事件被触发时,程序会等待该事件完成后才能继续执行下一个事件。
在左侧界面点击执行动作,配置连接器及其执行动作。a.选择连接器。b. 选择连接器的执行动作。c. 查看参数配置。出参/入参数据由对应连接器配置,你可以进行查看确认。
提示
除以上,支持通过以下操作来完善连接流:
点击:
添加执行动作。
添加条件分支,当表达式执行为true时,将执行该条件分支。
点击分支条件,并设置对应的条件表达式。
点击,确认当前所有配置项目是否已完成。
点击,确认连接流的执行是否无误、是否符合预期。
点击发布。
管理连接流
登录智慧空间服务平台。
点击 系统集成 > 系统连接器。
点击我的连接流。
在界面左侧,创建并管理文件夹,有序分类连接流。
点击任一连接流右侧编辑,编辑连接流。
点击任一连接流右侧 > 复制流,将该连接流复制至任一文件夹。
点击任一连接流右侧 > 查看webhook,将该连接流的webhook详情。
点击任一连接流右侧 > 移至文件夹,将该连接流移至任一文件夹。
点击任一连接流右侧 > 删除,将该连接流删除。
最佳实践
连接器平台介绍
一、功能介绍
智慧办公平台有较多与企业内丰富的业务系统对接的需求,系统连接器提供一种简捷的方式实现智慧办公平台与企业三方业务系统对接。原来系统间对接需要技术人员去开发才能实现, 耗时且成本高。如果通过系统连接器,可通过可视化的界面以低代码或零代码方式实现系统间互联对接,帮助企业降低了集成实施的周期和成本。
二、应用场景
与企业内部协同系统对接:通讯录需要同步企业微信/飞书/钉钉/OA的通讯录;日程业务需要对接企业微信/飞书/钉钉进行日程同步预约和管理;
与企业内部的会议系统对接:需要与腾讯会议、亿联会议等会议系统对接,进行线上会议的预约、管理,如预约线上腾讯会议、线下腾讯会议室;
与企业内部IBMS系统对接:平台与企业的IBMS楼宇自控系统对接,实现设备的智能联动,例如能够控制灯光、空调;
与企业内部的门禁、道闸系统对接:平台与门禁、道闸系统对接,实现访客联动业务,例如:访客签到后开启相关权限、会议日程签到后开启门禁权限等;
三、系统对接概要说明
目前提供内置对接和自定义对接两种方式:1、内置对接:智慧办公平台已内置常见的第三方系统的配置,企业只需要填写系统鉴权信息,即可完成对接,实现完全零代码互联对接,以企业微信对接为例,只需要在系统配置里填写系统对接所需鉴权信息,即可完成对接。2、自定义对接:企业内提供服务系统的厂商各式各样,若智慧办公平台未提供对应的内置对接,企业也可通过可视化低代码的方式进行配置,也可完成对接。前提:第三方服务系统厂商提供业务所需的HTTP API接口。具体操作可见下文中的实践教程。附:各业务对接概览:
业务名称
对接系统
内置业务流
对接方式
通讯录/日程业务
UME
通讯录同步; 日程创建、修改、取消业务对接。
内置对接,鉴权配置流程:1、UC 侧配置应用支持 Smart 侧进行对接。2、在Smart中配置。3、在业务集成中勾选UME,进行业务同步。
通讯录/日程业务
企业微信
通讯录同步 获取企微部门、子部门、部门下成员信息 创建、修改、取消企微日程; 发送企业微信通知。
内置对接,鉴权配置流程见: https://support.yealink.com/zh/portal/knowledge/show?id=66dfa91633eba8468add003a
通讯录/日程业务
飞书
通讯录同步 获取飞书部门信息、部门下成员信息; 查询飞书会议室忙闲状态; 飞书会议室层级信息、会议室列表信息; 获取飞书会议室日程主题和会议详情。
内置对接,鉴权配置流程见: https://support.yealink.com/zh/portal/knowledge/show?id=66dfe423e691ca5a4d5653b6
通讯录/日程业务
钉钉
通讯录同步 查询钉钉会议室忙闲状态; 获取钉钉部门信息、部门下成员信息; 获取会议室层级、会议室列表信息; 获取钉钉日程详情; 释放钉钉会议室。
内置对接,鉴权配置流程见: https://support.yealink.com/zh/portal/knowledge/show?id=66dfdf8011d5091881d81cac
视频会议平台
UME
预约、编辑、删除UME会议。
内置对接,鉴权配置流程:1、UC 侧配置应用支持 Smart 侧进行对接。2、在Smart中配置。3、在业务集成中勾选UME,进行业务同步。
视频会议平台
亿联会议
获取亿联会议用户列表 分页查询亿联会议rooms列表; 预约、编辑、删除亿联会议;
内置对接,鉴权配置流程:1、亿联会议侧配置,获取亿联会议 API。2、 Smart 侧根据亿联会议 API 进行对应配置。
视频会议平台
腾讯会议
预约、修改、删除腾讯会议; 查询、预定、释放腾讯会议室; 获取腾讯会议用户列表、设置。
内置对接,鉴权配置流程见: https://support.yealink.com/zh/portal/knowledge/show?id=66e1082de691ca5a4d565463
IBMS
达实
查询达实场景; 执行达实场景。
内置对接,鉴权配置流程:1、在 系统集成 > 系统配置中配置达实的信息。2、在 系统设置 > 业务集成中同步达实场景。
门禁
海康门禁
查询门禁点位信息; 下发、取消门禁权限。
内置对接,鉴权配置流程:1、在 系统集成 > 系统配置 中配置海康鉴权的信息。2、在 系统设置 > 业务集成 > 门禁 中选择海康门禁。
门禁
其他系统
根据第三方系统接口进行自定义配置。
自定义对接,见下文中的实践教程;
道闸
捷顺道闸
查询道闸信息 接收捷顺道闸入场过闸记录; 下发、取消捷顺道闸权限。
内置对接,鉴权配置流程:1、在 系统集成 > 系统配置 中配置捷顺鉴权的信息。2、在 系统设置 > 业务集成 > 道闸 中选择捷顺道闸。
道闸
其他系统
根据第三方系统接口进行自定义配置。
自定义对接,见下文中的实践教程。
系统连接器配置
连接器: https://support.yealink.com/zh/portal/knowledge/show?id=66d949db33eba8468adcfe33连接流: https://support.yealink.com/zh/portal/knowledge/show?id=66d94be62317ef117c718d72
实践教程
企业自主采购的门禁系统、道闸系统厂商各异,在访客预约业务中,需要跟门禁、道闸厂商进行对接集成,可使用系统连接器做低代码化自定义对接集成。
业务介绍
门禁系统对接业务:访客预约支持上传人脸,访客签到后,人脸能够录入到第三方门禁系统,在门禁上扫脸后,即可通行。
道闸系统对接业务:对于园区客户,需要在园区外部进行访客签到,允许发行后,将车牌录入到第三方道闸系统,车辆过闸时,即可通行。
基本流程
跟道闸、门禁系统的基本流程,如下图所述:
对接实例1-跟熵基门禁系统对接
第一步:第三方接口封装为连接器
根据熵基门禁提供的API接口( https://www.zkecopro.com/iclock/api/doc/index.html#mytab),按需封装为连接器,步骤如下:1、新建连接器:填写连接器名称、描述基础信息。2、鉴权配置:设置跟熵基对接鉴权所需的字段,熵基鉴权需要秘钥,因此选择自定义签名,鉴权字段设置为key,无需鉴权请求参数,配置后可鉴权调试验证效果。3、触发事件:门禁对接业务由智慧办公平台触发,没有从熵基触发的业务事件,因此无需封装触发事件接口。4、执行动作:封装第三方的接口为执行动作,门禁业务业务流串通需要人员管理、部门管理、门禁权限管理相关接口,将对应的接口进行封装,如下:以封装"下发门禁权限组"为例:按需将熵基提供的接口配置到执行动作,核心是HTTP接口地址和入参的配置,出参业务用不到可不进行配置。5、鉴权凭证配置:配置该企业跟熵基系统鉴权凭证,即具体的秘钥值;一般企业对接只需要一个凭证,若存在所需多个凭证的情况,也可以添加多个,在连接流配置中选择具体凭证进行鉴权。
第二步:业务流程串通
智慧办公平台侧封装了官方访客连接器,跟门禁相关的触发事件有"异步获取门禁二维码"、"异步查询门禁权限组"、"异步下发门禁权限"、"异步取消门禁权限",和对应的"异步获取门禁二维码回调"、"异步查询门禁权限组回调"、"异步下发门禁权限回调"、"异步取消门禁权限回调"执行动作,跟第三方门禁厂商对接需要配置获取门禁二维码、查询门禁权限、下发门禁权限、取消门禁权限这四个业务流程,即可完成对接;门禁业务连接流如下:
业务流
业务说明
熵基连接流配置
获取门禁二维码
在访客预约通过后,将访客信息下发到第三方系统中,有第三方系统生成二维码后返回到访客系统中显示。
由于熵基没有提供二维码生成接口,因此配置空接口回调,避免业务报错。
查询门禁权限组
进入访客系统的访客权限编辑中,需要获取到熵基门禁的门禁权限组进行展示和配置。
当访客系统触发查询门禁权限组触发事件时,调用熵基门禁-获取门禁权限组执行动作去获取权限组信息,再执行回调执行动作,将熵基返回的门禁权限组信息回调到触发事件中。
下发门禁权限
当访客签到后,需要将访客的权限下发到熵基门禁系统中,访客才能够刷脸进入;
由于无法获取到熵基成员名单,因此访客权限下发采取创建人员的方式,连接流为访客系统触发下发门禁权限事件后,调用熵基门禁更新人员动作将访客信息写入,再调用熵基门禁下发门禁权限执行动作,将门禁权限分配给成员,进行回调完成业务流配置。
删除门禁权限
当访客结束访问后,需要删除门禁权限;
当访客系统触发取消门禁权限触发事件后,执行熵基门禁删除成员,进行回调完成业务流配置。
以"下发门禁权限"业务流为例,配置步骤为:1、创建连接流,设置连接流名称。2、触发事件选择:官网连接器-访客-下发门禁权限。3、新增执行动作:新增自建连接器-熵基门禁-更新人员执行动作,选择鉴权凭证,进行出入参参数映射配置将访客信息映射传入熵基门禁系统。 4、新增执行动作:新增自建连接器-熵基门禁-下发门禁权限组,选择鉴权凭证,进行出入参配置,将访客信息和权限等级信息传入熵基门禁系统。 5、新增执行动作:新增官网连接器-访客-下发门禁权限回调执行动作,进行出入参配置,完成业务流配置。
第三步:业务集成选择
当所有的连接流配置完成后,在业务集成界面中,选择自建连接器,即可完成对接;
对接实例2-跟海康道闸系统对接
第一步:第三方接口封装为连接器
根据海康门禁提供的API接口,按需封装为连接器,步骤如下:1、新建连接器:填写连接器名称、描述基础信息。2、鉴权配置:跟海康道闸接口调用无需鉴权,则鉴权方式选择无鉴权。3、触发事件:门禁对接业务由智慧办公平台触发,没有从海康道闸触发的业务事件,因此无需封装触发事件接口。4、执行动作:封装第三方的接口为执行动作,道闸业务流串通需要新增车辆预约、取消车辆预约、新增固定车、删除固定车接口,将对应的接口进行封装,如下。以封装"新增固定车"为例:按需将海康提供的接口配置到执行动作,核心是HTTP接口地址和入参的配置,出参业务用不到可不进行配置。5、鉴权凭证配置:海康无需鉴权,则不需要配置鉴权凭证。
第二步:业务流程串通
智慧办公平台侧封装了官方访客连接器,跟道闸相关的触发事件有如下:道闸业务连接流如下:
业务流
业务说明
海康连接流配置
订阅道闸事件
有些厂商道闸开闸事件需要去订阅,因此预留该触发事件,可将该事件的webhook地址配置到第三方厂商系统中,当道闸系统发生开闸事件时,会通过该订阅触发事件进行触发;
海康道闸无需订阅道闸事件,无需配置对应连接流;
获取道闸权限组
进入访客系统的访客权限编辑中,需要获取到道闸的权限组进行展示和配置;
由于海康没有提供获取道闸权限组接口,因此配置回调时返回默认固定权限组,避免业务报错,即默认所有的停车场道闸都能进;
下发道闸权限
当访客审批通过,需要将访客车牌信息下发到道闸系统中,访客车辆过闸方可进入;
当访客系统触发异步下发道闸权限后,调用海康道闸的新增固定车接口,将车牌信息进行写入,再进行回调完成业务流;
取消道闸权限
当访客当天结束,需要将车牌车牌权限从道闸系统重收回;
当访客系统触发取消道闸权限时,调用海康道闸的删除固定车接口,将车牌信息删除,在进行回调完成业务流;
以"下发道闸权限"业务流为例,配置步骤为:1、创建连接流,设置连接流名称;2、触发事件选择:官网连接器-访客-异步下发道闸权限。3、新增执行动作:新增自建连接器-海康道闸-新增固定车执行动作,进行出入参参数映射配置将车牌信息映射传入海康道闸系统。 4、新增执行动作:新增官网连接器-访客-异步下发道闸权限回调执行动作,进行出入参配置,完成业务流配置。
第三步:业务集成选择
当所有的连接流配置完成后,在业务集成界面中,选择自建连接器,即可完成对接。