跳到主要内容
版本:6.0.0

钉钉完全集成方案

1. 钉钉完全集成方案概述

钉钉,阿里巴巴出品,专为全球企业组织打造的智能移动办公平台。观远数据支持与钉钉的深度集成,通过钉钉后台与观远数据管理员设置的简单操作,即可进行集成,打通两个平台的账号体系,进行便捷操作。

2. 钉钉完全集成价值

观远数据支持与钉钉的深度集成,可实现:

  • 观远平台成为钉钉内嵌应用;

  • 钉钉应用内免密登录(包括移动端和PC端);

  • Web端可用钉钉扫码登录;

  • 订阅预警消息推送至钉钉,一键触达。

SaaS支持钉钉集成吗?

3. 集成配置步骤

3.1 切换旧版配置

钉钉已对企业应用接入进行了接口等内容改版。当前登录开发者后台,默认显示的是新版,需在页面右上角先切换为旧版,再按照以下步骤进行配置。(旧版配置完成后,不影响您切换到新版的使用)

  • 注:钉钉集成仅限私有化部署客户。SaaS环境(app.guandata.com) 由于钉钉官方限制了单个IP只能被一个公司使用,暂不支持钉钉账户集成。观远分析云不受此限制的影响。

3.2 “钉钉后台”在钉钉开放平台创建钉钉移动接入

首先我们需要在钉钉开放平台创建一个扫码登录应用,这是观远平台支持钉钉免密登录与Web扫码登录的前提。

在钉钉开放平台->应用开发->移动接入应用->登录,创建扫码登录应用授权。

直达地址为:https://open-dev.dingtalk.com/#/loginMan

示例如下:

其中回调域名是客户私有化环境的移动端域名。如明确知道域名,可直接填写;如不知道,可从观远管理后台获取。

观远管理后台中有2个地方可看到此信息,一是域名设置入口:管理员设置—系统设置—高级设置—域名设置。

初始状态是http://localhost:3001/,需改成企业实际域名。

上图设置后,钉钉的移动端回调域名,可在系统集成—钉钉中看到,如下:

扫码登录应用创建完后,可以在列表中看到该新增的App:

同时我们可获取该App的AppID和AppSecret,用于随后在观远管理后台进行配置。

3.3 “观远管理后台”填写钉钉的扫码登录应用信息

为了让观远平台能够跳转到正确的钉钉授权页面,完成正确的用户登录流程,以及提供消息推送等相关功能,我们需要在观远平台内配置相关的钉钉应用信息。

管理员登录到观远平台,在管理员设置->系统集成->钉钉配置页面,填写扫码登录应用信息,具体包括AppID和AppSecret。

填写完毕后可获取应用首页链接以及PC端首页链接,用于随后在钉钉后台进行微应用配置。

3.4 “钉钉后台”在钉钉工作台创建观远BI应用

我们需要在钉钉工作台里内嵌观远的微应用,操作方式:

创建入口:钉钉开放平台->企业内部开发->H5微应用->创建应用,直达地址为:https://open-dev.dingtalk.com/#/corph5

点击“创建应用”后,填写相关信息,示例如下:

3.4.1 填写基本信息,包括应用名称、应用描述、应用图标和开发方式

注:开发方式请选择“企业自助开发”。

创建成功后,会自动跳转到应用详情页。在“凭证与基础信息”Tab页,显示该应用的AgentId、AppKey、AppSecret信息,这三个信息将在接下来“3.5观远后台配置钉钉微应用信息”时用到。

3.4.2 点击“开发管理”Tab页,配置相关信息

注1:开发模式,请选择“开发应用”。

注2:请将观远平台公网IP添加到“服务器出口IP”中。

注3:应用首页地址和PC端首页地址可以在观远管理员设置——系统集成——钉钉中获取。

注4:管理后台地址,一般可填相应观远平台的主页地址,即回调域名。

注5:如果不需要配置钉钉免密登录,上述3个链接直接填写观远平台的主页地址即可。

注6:详情请参考《配置链接》

报错详见 oapi.dingtalk.com: Name or service not known

3.4.3 在“权限管理”Tab页,设置应用的接口权限

下图中的权限范围,若想选择为“部分员工”,请使用最新版钉钉。

“接口权限”配置中,请确保该微应用已获得“身份验证”、“消息通知”和“通讯录只读”权限。

3.4.4 发布应用并设置可见范围

以上信息确认无误后,在“版本管理与发布”Tab页,发布应用。

发布后,设置该应用对哪些用户可见。

3.5 “观远管理后台”填写钉钉的微应用信息

在观远管理员设置->系统集成->钉钉配置页面,填写微应用信息,具体包括AgentId、AppKey和AppSecret(获取入口如2.4.1所述)。

填写后,需要"启用",才能正常进行钉钉消息推送和免密/扫码登录。

3.6 “观远管理后台”在观远后台关联账号

钉钉应用配置"启用"后,系统会自动添加一个用户基础属性——“钉钉账号”。

管理员可以在单个用户详情页给某个用户添加,也可以在"用户基础属性"中批量配置。

钉钉账号的获取方式有以下几类:

(一)获取单个用户的钉钉账号 

用户的钉钉账号,可在钉钉管理后台,通讯录>内部通讯录管理>组织架构>部门人员,点击相应用户。

(二)批量导出钉钉用户的账号 

也可以通过批量导出的方式批量获得钉钉用户的账户:

(三)自动化拉取钉钉用户列表与属性 

观远数据产品通过【账户数据集】与【账户同步】功能已经支持自动化拉取钉钉的用户列表与用户组列表,并将相应属性同步到观远用户体系中。  

相关参考资料:

- 账户数据集   - 账户同步能力介绍 账户同步实践参考 

3.7 免密登录到表单

如果需要免密登录到表单填报里,则需要在配置的链接里,host_url后加一个固定的路由(如下),再按照第三方集成要求添加其他参数。

?path_url=survey-engine/ 

例如:

https://app.mayidata.com?path_url=survey-engine%2Fm%2Fsurvey%2F4bd86aa5-89d3-4b72-8186-a06170cdddbd

填报链接做免密登录链接拼接注意点:

(1)在survey-engine前要加指定参数 “path_url=”

注:参数不能直接跟在“/”后面,只能跟在“?”后面

(2)填报链接要做转码

注:转码可以使用一些小工具,如:https://www.bejson.com/enc/urlencode

举例:

表单链接:

https://app.mayidata.com/survey-engine/survey/1b36b7ff-d470-475e-931f-df1ce53b3ed5

拼接后的免密登录链接:

https://app.mayidata.com?path_url=survey-engine%2Fsurvey%2F1b36b7ff-d470-475e-931f-df1ce53b3ed5&……(其他参数)

4. 效果演示

(1)PC端登录页面出现 钉钉登录入口,点击后可扫码登录。

(2)企业员工的钉钉APP中,在工作台->其他应用中,可看到创建的应用,点击进入后,通过简单的授权,即可完成免密登录到观远平台H5界面。

(3)钉钉PC端应用中,在OA工作台可以看到观远平台应用入口,点击后,通过简单授权(若移动端已授权,则这边就不需要再次授权),即可完成免密登录到观远平台web端界面。

(4)订阅、预警消息推送至钉钉:在配置订阅、预警通知渠道时,可以选择“钉钉”作为触达方式。

最后,需要注意的是:

钉钉免密登录、扫码登录、消息推送的集成适用于私有化部署用户。

SaaS环境由于钉钉限制了单个IP只能被一个公司使用,因此暂不支持钉钉账户集成,但您可以做钉钉内嵌应用的简单集成,通过记住密码来实现快捷登录。

私有化部署集成钉钉时,请确保观远服务器与钉钉服务器的网络连通

关于钉钉企业微应用开发的更多资料,可查看相关官方文档,如链接:

https://open-doc.dingtalk.com/docs/doc.htm?spm=a219a.7629140.0.0.mXGeHZ&treeId=367&articleId=104938&docType=1