第三方企业应用可以将应用的数据通过连接器的方式进行开放,第三方连接器发布成功后可以让其他组织使用。
接入流程
第三方连接器创建流程如下:

如果需要接收到企业开通的通知,可以通过企业开通连接器订阅事件(main_data_subscribe),详情请参考企业授权开通应用事件。
准备工作
使用连接平台之前,你需要有已有上架到应用市场的应用,详情请参考应用上架全流程指引。
步骤一:创建连接器
- 登录开发者后台。
- 依次选择开放能力 > 连接平台>连接器。
- 单击创建连接器,选择要关联的第三方企业应用,并输入连接器的基本信息,然后单击确定。
步骤二:配置连接器
一个连接器至少包含一个触发事件或一个执行动作。
配置触发事件
- 选择创建的连接器进入详情页面,然后依次选择触发事件 > 创建触发事件。
- 填写触发事件的基础信息,然后单击下一步。
- 在模型配置界面下,配置触发事件入参参数,然后单击保存。
- 在触发事件列表,选择创建好的触发事件,依次单击更多命令>调试进行调试。
- 触发的连接器事件发送到钉钉连接器服务中,钉钉会将这些事件再广播转发给订阅了此事件的其它业务系统,触发方式主要有以下两种方式:
配置执行动作
- 选择创建的连接器进入详情页面,单击执行动作,进入执行动作配置页面。
- 填写执行动作基础信息,单击下一步。
- 在入参配置界面,根据接口的实际入参填写,然后单击下一步。
- 在出参配置界面,根据接口的实际出参填写,最后单击发布。
- 在执行动作列表下,选择创建好的执行动作,然后依次选择更多命令 > 调试,进行调试。
- 在调试界面,输入VALUE值,单击调试,如下图:
步骤三:配置灰度企业
有灰度企业
如果你已经有自己的灰度测试组织,可以直接按照以下步骤添加灰度测试组织。
- 单击进入已创建的连接器页面,然后单击灰度企业。
- 单击右上角添加,然后在弹出的添加灰度组织页面,添加需要灰度的组织的corpId。

步骤四:提交测试
测试目标
为保障上架连接器的质量,上架前要求必须通过平台基础准入测试以及做好完备自测。
测试用例包括:
类型 | 测试用例 |
---|---|
触发事件 | 必填字段检测(包括自定义的或关联主数据定义的) |
参数类型检测:调用时的传参与触发事件定义入参的字段类型完全匹配,不出现类似于定义入参类型为Number,传递过来值为非数字String类型的错误情况 | |
应用内操作触发事件后,消息可触达连接平台(针对连接器关联应用的场景) | |
执行动作 | “调用成功规范”状态码配置正确 |
接口能正常接收请求,并在正确处理请求后返回满足“调用成功规范”中所定义状态码的预期结果 | |
并发10QPS的情况下,接口稳定 | |
接口满足幂等性,正确入参重复请求不影响返回结果 | |
接口RT < 2S |
测试步骤
- 单击配置好的连接器,选择基本信息,在市场上架栏单击测试按钮。
- 在列表页中,选择想要上架的触发事件和执行动作,选中后单击提交测试。
选择的触发事件提交测试后,触发事件会变为待调用状态。
- 选择的执行动作提交测试后,执行动作可能会有两个状态。
- 按定义的入参结构填入需要的参数后发起测试,填写完成后单击发送发起调试。
- 全部测试完成后,在测试列表页可以看到所有测试的结果。
连接器上架的时候只有测试状态为测试成功的触发事件和执行动作才允许上架。
步骤五:上架连接器
请确保选择和定义正确的数据模型,所有执行动作通过测试以后,连接器应用达到待发布状态。
- 进入已完成配置的连接器基本信息页面,单击市场上架栏右侧上架。
- 在上架连接器页面,填写上架说明。
- 提交连接器发布申请后,钉钉小二会在收到发布申请后的3个工作日内审核完成。你可以在开发者后台 > 连接器 > 连接器详情页面中查看审核状态。
连接器审核标准如下: