文档

如何使用钉钉连接模块集成钉钉侧能力

更新时间:

魔笔平台提供钉钉连接模块,提供与钉钉组织架构进行数据打通的能力,本文介绍如何使用钉钉连接模块。

适用场景

钉钉连接模块通过连接器接入了钉钉开放平台中和组织架构相关的API,用户可以通过调用钉钉连接模块中的集成API和钉钉进行数据的双向同步。

模块介绍

钉钉连接模块集成了钉钉开放平台中用户管理、角色管理、角色组管理、部门管理的API接口,便于快速连接钉钉组织架构。

  • 钉钉连接模块接口API。

    image.png image.png

  • 钉钉连接模块接口API的结构体。

    image.png image.png

操作步骤

通过以下步骤,可实现在自建的魔笔应用内,基于钉钉连接模块,通过逻辑流调用的方式集成钉钉API,实现魔笔应用与钉钉数据的打通。

步骤一、收藏模块

物料市场收藏钉钉连接模块,具体操作请参见收藏应用模板和模块

步骤二、引用模块

在魔笔应用设计器左侧选择image,单击添加引用模块,在引用模块管理中,引用钉钉连接模块,具体操作请参见引用模块管理

引用成功后引用模块管理显示钉钉连接模块

image

步骤三、新建逻辑流

在逻辑流中通过后端调用集成API操作集成钉钉API。前端逻辑流和后端逻辑流中都可使用后端调用集成API操作。本文以新建前端逻辑流为例说明。

image

步骤四、使用集成API

本文以集成API获取角色列表为例说明如何集成钉钉API。

  1. 在逻辑流中拖入后端调用集成API,并设置其属性。

    • 节点标题:获取应用token

    • API:钉钉连接模块 > 获取应用token

    • 请求参数设置:钉钉的appkey和appsecret,获取方式请参见步骤六、配置钉钉应用

    image
  2. 在逻辑流中拖入创建结构体对象,并设置其属性。

    • 结构体类型:钉钉连接模块 > 角色管理-获取角色列表

    • 结构体对象名称:获取角色列表接口参数

    image
  3. 在逻辑流中拖入后端调用集成API,并设置其属性。

    • API:钉钉连接模块 > 角色管理-获取角色列表

      image
    • 请求参数设置:access_token,即token返回对象的access_token。

      image
    • RequestBody设置:获取角色列表参数

      image

    ApiResponse为接口返回值,返回一个角色列表,可使用该返回值进行后续数据处理。例如:展示所有角色、展示用户拥有的角色、为用户分配角色提供数据。

  • 本页导读