钉钉集成说明和步骤

概述

在HAP中搭建的应用，可以直接安装在钉钉的工作台，您可以在钉钉中就能体验HAP的服务。区别于一般的SaaS与钉钉集成方案，我们采用了钉钉自建内部应用的方式进行集成。效果如下图：

电脑端效果：
通过系统默认浏览器或钉钉内，打开HAP。
HAP：将整个平台集成到钉钉工作台
OKR：将单个应用集成到钉钉工作台
手机端效果：

免费版不支持集成钉钉

集成操作步骤

步骤简述

在钉钉管理后台安装一个微应用，建立钉钉和HAP的信息对接。
同步钉钉通讯录，完成HAP集成到钉钉。
优化配置：将待办消息（审批、填写）同步到钉钉
将HAP的单个应用安装在钉钉工作台。

请严格按照以下步骤进行操作，任何一步出错都会导致集成失败。

一、建立钉钉和HAP的连接

1、打开HAP对接指南页面

HAP管理员点击个人头像进入组织管理后台，点击第三方平台，选择钉钉进入集成页面。然后点击如何获取对接信息打开对接操作指南页面，此页面不要关闭，后面的步骤需要页面中的以下信息：

LOGO （第3点）
应用首页地址（第4点）
PC端首页地址（第4点）

企业微信、钉钉、钉钉只能选择一个平台对接，如果已经对接了一个，另外两个就不再显示了。如何关闭对接

2、在钉钉中创建对接应用

钉钉管理员需要登录钉钉网页版的开放平台后台，创建内部应用。

应用图标LOGO可从第1步打开的页面中下载。

3、添加网页应用能力

4、填写首页地址

打开[开发管理]栏，点击右上角编辑按钮，填写将对应的首页地址填入。

应用首页地址和PC端首页地址请在第1步打开的对接指南页面的[完成接口信息]中复制

5、确定同步的员工范围

特别重要！

贵司使用钉钉的人员是100人，但是使用HAP的人数可能是50人，因此并非同步所有的账号。我们可以根据部门和指定人员来确认好同步的人员范围，设定范围如下图：如果所有人员使用，直接选择“全部员工”即可。如果不是全员使用HAP，则选择指定员工或部门即可。

6、获取通讯录权限接口

特别重要！

需要获取钉钉组织内的通讯录读取权限，必须添加的权限有以下7个，逐个复制名称搜索后，点击右侧的申请权限会自动获得。

通讯录部门信息读权限
通讯录个人信息读权限
成员信息读权限
通讯录部门成员读权限
企业员工手机号信息
个人手机号信息
邮箱等个人信息

7、发布应用

完成以上步骤后，钉钉的配置已经完成，接下来需要创建应用版本并发布应用，让成员可以使用，保存后直接发布生效。

版本号
第一次集成就写1.0.0 ，如果后面有小的改动，可以后面增加为1.0.1 、1.0.2. 如果有稍大的版本，可以设为1.1.0...，如果有重大版本更新时，可以设置2.0.0，当然这并非绝对的，只要新版本号比旧版本号大即可。
版本描述
简要描述本次做了什么配置
待发布内容
选择“网页应用”
可见范围
第4步设定的范围是同步账号的人员范围，如果需要同步的人在钉钉工作台可见HAP应用，还需要设置以下范围，这部分人在钉钉工作台可以看见HAP应用的入口。
在测试阶段，可先选择部分人员可见。这样就只有几个人在钉钉工作台可看到HAP应用。
待后面的步骤也测试完毕后，确认正式使用了，再回来修改应用的可见范围并发布新版即可。这里选择的人，在钉钉工作台都会看到HAP应用。一般和第4步同步范围选择的人员是一致的。

二、在HAP同步数据

1、录入钉钉中的信息

组织管理员返回HAP后台的钉钉对接界面，将CorpId等4个对接信息录入。

获取CorpId等4个对接信息的方法如下：

AgentId、ClientID、ClientSecret
进入钉钉中创建的应用详情，点击凭证与基础信息，获取3个信息。
CorpId
在钉钉开放平台首页可直接找到CorpId。

点击保存，并确定如何处理映射关系

2、同步通讯录

点击【同步】按钮，可以将钉钉的通讯录同步到HAP。

同步的信息有：姓名，公司，联系电话，部门，职位，头像。

每次同步钉钉的信息都会覆盖写入HAP，但HAP头像只在第一次同步时会覆盖。

同步前必看

将钉钉通讯录同步到HAP，是依据手机号和邮箱（优先手机号）进行匹配关联的。如果HAP的组织中有相同手机号的账户，则直接建立和钉钉账号的关联，如果没有则自动创建新的HAP账户。也就是说，能和现有HAP账户关联有两个条件：

两个平台间绑定的手机号相同
HAP账号要在组织内

示例：在钉钉中，员工绑定的手机号是199-9999-9999，在同步到HAP的组织时，这个组织内有个账户也绑定了手机号199-9999-9999，如果有则直接关联，如果没有，则自动创建一个新的账户并关联。如果HAP系统中现在有个199-9999-9999的账户，但不在您的组织内，依然不会同步并关联的，而是自动创建一个新的HAP账户。