连接器
连接器指触发事件和业务执行的集合,包含了若干触发事件和执行动作,可以实现异构系统之间的互联互通。主要包括三大类:自建连接器、官方连接器、系统内置连接器。
自建连接器:由你在企业管理平台自行创建,并需要自行配置鉴权方式、触发事件与执行动作等。
官方连接器:由厂商提供,无需配置直接可用,如:消息、群管理等。
系统内置连接器:系统内置的基础连接器,如:同步回调。
连接流能够将各连接器通过零代码方式互联在一起,形成完整的事件流,如:当连接器A同步触发某事件,连接器B将执行某动作。
创建自建连接器
以企业管理员身份 登录企业管理平台。
点击 应用管理 > 系统连接器。
点击创建连接器。
输入连接器的名称与描述,点击保存。
编辑连接器信息。
基本信息
编辑连接器的名称与描述。
鉴权设置
鉴权用于校验用户是否有权限访问接口,连接器内的所有执行动作共用这套鉴权设置,用户完成鉴权才可调用该连接器的执行动作。
第一步:设选择鉴权方式
无鉴权:用户无需进行鉴权。
Token鉴权:自定义Token鉴权方式。
自定义签名:自定义签名鉴权方式。
使用已有鉴权:直接使用已有的UC官方接口鉴权方式。
域名变量:开启后将设置接口域名为环境变量。若为不同客户提供服务的域名不相同时,可开启本开关,开启后域名由客户自行配置。
说明
若使用已有鉴权,则无需进行下述鉴权设置。
设置鉴权字段:自定义对应的鉴权字段,可在下方预览用户的鉴权界面。
若选择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 / boolen。
执行动作
定义被其它系统连接的能力,例如提供接口来提供系统的数据或者消费其它系统推送过来的数据。
点击创建执行动作。
编辑执行动作基本信息,点击下一步。
按照格式进行HTTP设置、API入参及API出参设置。
进行调试,你可以自行检查返回结果是否符合预期。
点击发布。
鉴权凭证
根据你的鉴权设置按需填写鉴权凭证。支持新增/编辑/删除凭证。
管理自建连接器
以企业管理员身份 登录企业管理平台。
点击 应用管理 > 系统连接器。
点击任一连接器右侧设置,修改连接器配置。
点击任一连接器右侧删除,将连接器删除。
连接流
连接流能够将各连接器通过零代码方式互联在一起,形成完整的事件流,如:当连接器A同步触发某事件,连接器B将执行某动作。
前提条件
你已创建并配置好相关连接器。更多信息,请参阅:连接器。
创建连接流
以企业管理员身份 登录企业管理平台。
点击 应用管理 > 系统连接器。
点击我的连接流。
点击创建连接流。
配置流程。
说明
在界面右侧按照步骤配置,在界面左侧选择对应的模块,并能够总览整个事件流程。
在左侧界面点击触发事件,配置连接器及其触发事件。a.选择连接器。b. 选择连接器对应的触发事件。
c. 查看参数配置。出参/入参数据由对应连接器配置,你可以进行查看确认。
异步触发事件:事件的执行是非阻塞的,即一个事件的触发不会等待该事件完成,而是立即继续执行后续的代码。
同步触发事件:事件的执行是按照严格的顺序进行的。当一个事件被触发时,程序会等待该事件完成后才能继续执行下一个事件。
在左侧界面点击执行动作,配置连接器及其执行动作。a.选择连接器。b. 选择连接器的执行动作。c. 查看参数配置。出参/入参数据由对应连接器配置,你可以进行查看确认。
提示
除以上,支持通过以下操作来完善连接流:
点击:
添加执行动作。
添加条件分支,当表达式执行为true时,将执行该条件分支。
点击分支条件,并设置对应的条件表达式。
点击,确认当前所有配置项目是否已完成。
点击,确认连接流的执行是否无误、是否符合预期。
点击发布。
管理连接流
以企业管理员身份 登录企业管理平台。
点击 应用管理 > 系统连接器。
点击我的连接流。
在界面左侧,创建并管理文件夹,有序分类连接流。
点击任一连接流右侧编辑,编辑连接流。
点击任一连接流右侧 > 复制流,将该连接流复制至任一文件夹。
点击任一连接流右侧 > 查看webhook,将该连接流的webhook详情。
点击任一连接流右侧 > 移至文件夹,将该连接流移至任一文件夹。
点击任一连接流右侧 > 删除,将该连接流删除。