配置连接器

更新于 2024-02-02

一个连接器至少包含一个触发事件或一个执行动作。

配置触发事件

  1. 选择创建的连接器进入详情页面,然后依次选择触发事件 > 创建触发事件

  2. 填写触发事件的基础信息,然后单击下一步

    说明

    集成类型中“网关集成”以及“是否加入主数据联盟”选项需要在基本信息 > 高级设置中开启对应设置。

  3. 在模型配置界面下,配置触发事件入参参数,然后单击下一步

  4. 在调试界面下,填写触发事件入参参数,然后单击立即调试。调试成功的用例,可以点击保存调试用例,方便下一次调试。

  5. 调试完成之后,可以选择保存草稿或者直接发布

  6. 触发的连接器事件发送到钉钉连接器服务中,钉钉会将这些事件再广播转发给订阅了此事件的其它业务系统,触发方式主要有以下两种方式:

    • 方式一(推荐):通过Webhook地址触发事件

      1. 在触发事件列表,选择创建好的触发事件,依次单击更多命令>查看Webhook

      2. 复制Webhook地址。

      3. 打开接口请求工具,将获取的Webhook地址放到request URL中,并将请求类型设置为POST

        说明

        能请求钉钉接口的系统或工具,此处以postman工具作为演示。

      4. 选择Body,然后选择JSON数据类型。

      5. 构建请求参数,并单击Send发起请求。

    • 方式二:通过接口触发事件

      通过调用发送连接器事件接口,触发连接器事件。

配置执行动作

  1. 选择创建的连接器进入详情页面,单击执行动作,进入执行动作配置页面。

    说明

    配置执行动作可以采用“创建执行动作”以及“从postman导入”。

  2. 填写执行动作基础信息,单击下一步

    说明
    1. 下图使用的接口是测试接口,在实际中需要用到自己系统内部的真实接口。

    2. 集成类型-网关集成,需要到我的连接-连接器-基本信息-高级设置开启集成网关。

    3. 接口路径-使用连接器域名,需要到我的连接-连接器-基本信息-高级设置开启域名变量。

    4. 当连接器接口域名已声明为模板变量,则域名显示“接口域名已声明模板变量”;若没有声明模板变量,该域名位置自动显示接口域名值。关于模板变量的更多内容,请参考模板变量

  3. 在入参配置界面,根据接口的实际入参填写,然后单击下一步

    说明

    启⽤⼊参映射为可选,在不改变API⼊参的情况下,重新定义该执⾏动作对外的⼊参模型。

  4. 在出参配置界面,根据接口的实际出参填写,然后单击下一步

    说明

    启⽤出参映射为可选,在不改变API出参的情况下,重新定义该执⾏动作对外的出参模型。

  5. 在调试界面下,填写执行动作入参参数,然后单击调试。调试成功的用例,可以点击保存调试用例,方便下一次调试。

    说明

    如果在入参配置和出参配置开启了参数映射,则在调试结果中,可以查看API入参结果和API出参结果。

  6. 调试完成之后,可以选择保存草稿或者直接发布

这篇文档是否有帮助?
点击纠错