创建连接器

更新时间:
复制 MD 格式

AppFlow提供了大量的主流SaaS应用以及云产品的公共连接器。若用户有自研的应用需要被集成时,可以使用AppFlow提供的自定义连接器的功能,可以简便地将自研或采购的SaaS应用封装成AppFlow的连接器,参与到后续的连接流中。本文介绍创建自定义连接流的详细信息。

背景信息

  • 连接器(Connector):用于连接不同系统和应用,使数据可以在不同系统和应用之间流动。连接器包含鉴权设置、触发器和执行动作等。

  • 触发器(Trigger):启动工作流的条件或事件,可以是时间计划或其他系统事件。

  • 执行动作(Action):执行动作是工作流中具体需要执行的操作,例如调用外部系统API来实现某个业务操作。

操作步骤

  1. 登录AppFlow控制台

  2. 在左侧导航栏中,选择连接器 > 自定义连接器,然后在自定义连接器页面中,单击创建连接器

  3. 在创建连接器页,配置连接器信息。

    配置项

    配置说明

    连接器图标

    上传连接器的展示图标。建议上传图标的像素为192x192,支持jpg、png、svg格式。

    连接器名称

    配置连接器名称。名称长度在3~200个字符之间,一个中文字等于2个字符。

    连接器描述

    配置连接器描述。描述长度在10~500个字符之间,一个中文字等于2个字符。

    连接器类型

    选择连接器的类型。

    • 应用连接器:具有标准接口(Http/Https)的应用服务。

    • 数据连接器:暂未开放。

  4. 单击保存连接器,进入连接器详细配置页。

    1. 基本信息区域,查看连接器基本信息。连接器详细配置页左侧为四步骤导航,当前处于第一步 基本信息,右侧展示连接器名称、描述、协议类型(Http)及连接器类型等属性。

    2. 鉴权设置区域,选择连接器的鉴权方式。

      AppFlow连接器默认无需鉴权。若选择了鉴权方式,则用户在使用该连接器时,需要先填写授权信息。鉴权设置的详细信息,请参见连接器鉴权方式说明

      可选的鉴权方式包括无鉴权Basic AuthBearer TokenAppCode

    3. 触发事件区域,添加连接器的触发事件。

      触发事件是连接流的触发节点,是触发流程运行。如果连接器不具备触发事件的能力,可以跳过改步骤。触发事件的详细信息,请参见连接器触发事件说明

      1. 单击创建触发事件,进入创建触发事件页面。

      2. 并在基础信息页签中,设置出发事件的名称和描述,然后单击下一步

      3. 模型配置页签,中配置触发事件的入参。

        当触发事件被触发时,触发请求中所携带的入参数可以在后续流程节点中被引用。页面提供入参字段表格,包含字段key字段名称字段类型必填字段描述列,默认存在一行 root 节点(类型为 object)。可单击导入json批量导入字段结构,或通过添加链接逐行新增子字段。配置完成后单击发布

      4. 单击发布,完成触发事件的创建。

    4. 执行动作区域,创建连接器的执行动作。

      执行动作一般由 API 和其对应的出入参构成,执行动作能够作为连接流的执行节点,在流程运行到该节点时,完成特定的业务处理。

      1. 单击创建执行动作

      2. 在基础信息页签中,设置执行动作的名称、描述和接口路径,然后单击下一步

      3. 入参配置页签中,设置执行动作的API入参信息,然后单击下一步

      4. 出参配置页签中,设置执行动作返回结果信息。在 出参配置 页签中,选择 响应体 Tab,设置 API 出参字段。例如,添加 code(错误码,number 类型,描述为200:成功)、message(错误消息,string 类型,描述为ok)、data(返回对象,string 类型)等字段。也可单击 导入json 批量导入字段。

      5. 单击发布,完成执行动作的创建。