钉钉集成
注意:
- 本节仅适用于单独购买该插件的企业用户。免费用户请忽略本环节。
- 钉钉对接要求可道云必须有公网IP或者公网域名地址。
- 可道云服务器时间需与标准时间一致,否则登录可能出现”签名时间戳参数超时“的报错提示。
Kod的钉钉插件,是结合钉钉中的自建应用(免密登录),来实现钉钉通讯录信息同步和网页扫码登录。
钉钉集成功能概述
- 用户数据集成:钉钉用户集成同步到可道云。
- 部门数据集成:钉钉部门集成同步到可道云。
- 用户实时同步:在钉钉后台新增、修改、删除用户, 数据自动实时同步到可道云。
- 部门实时同步:在钉钉后新增、修改、删除部门, 数据自动实时同步到可道云。
- 钉钉APP中单点登录:在钉钉中打开可道云应用,能自动识别当前登录的用户并自动登录对应账号。
- 钉钉扫码登录可道云:电脑/浏览器端访问可道云地址, 通过钉钉扫码可以实现自动登录。
对接流程
1. 插件中心安装插件
管理员登录;插件中心,安装『钉钉同步』插件。 在钉钉插件配置界面,需填写如下6个参数,以完成配置:
- 企业应用
CorpId
- H5微应用
AgentId
- H5微应用
AppKey
- H5微应用
AppSecret
- 扫码登录
AppId
- 扫码登录
AppSecret
通过后续步骤,可获取到相关参数。
2. 企业应用CorpId
如尚未注册钉钉,请前往 注册
登录钉钉后台,导航栏【工作台】,点击自建应用,进入新页面。在新页面右上方可获取到企业应用CorpId [1]
3. H5微应用
注意:
- 服务器出口IP是钉钉方面限制的白名单, 如果有变更, 请及时修改, 否则将无法使用钉钉登录。
- 点击【创建应用】:
- 应用类型:H5微应用
- 开发方式:企业自主开发
- 创建完成后,进入应用详情页:
- 应用信息:可获取到微应用
AgentId [2]
、微应用AppKey [3]
、微应用AppSecret [4]
。
- 应用信息:可获取到微应用
- 进入开发管理页, 修改:
- 开发模式:开发应用
- 服务器出口IP:KOD服务器外网IP;
- 其余3项地址:填写[kod地址], 如
https://kod.kodcloud.com
- 进入权限管理页, 修改:
- 权限范围:全部员工。如需排除部门或用户,可在钉钉插件配置中进行
- 接口权限-通讯录管理:全部申请开通。
- 应用发布
- 部署与发布-版本管理与发布,点击【确认发布】。
- 发布后,用户可以在钉钉【工作台】看到该应用。
4. 扫码登录
进入旧版工作台
导航栏【应用开发】,选择 移动应用接入,创建扫码登录应用授权。
- 授权LOGO地址:
[kod地址]/static/images/icon/fav.png
, 或者使用其他图片地址 -
回调域名:
[kod地址],如 https://kod.kodcloud.com/
- 创建后,可获取扫码登录
AppId [5]
, 扫码登录AppSecret [6]
- 在配置到插件后, 可以在浏览器使用钉钉扫码登录可道云
5. 同步方式
可道云提供了两种同步钉钉通讯录的方案:实时推送、定时拉取。
- 实时推送:填写 回调校验aesKey (长度固定43位的随机字符串),点击【注册回调地址】按钮进行回调注册。 注册成功后,如果钉钉通讯录的数据发生变动,会实时推送到kod系统,kod接收数据后进行更新。
提示:
- 此方式只有在钉钉通讯录发生变化时才进行推送(且只推送有变化的部分),因此在完成插件配置后,需在【同步设置】页点击【手动同步用户数据】,进行一次数据初始化同步。
- 定时拉取:kod系统通过钉钉提供的接口,定时拉取(时间推荐默认填写的240分钟,数据量较大时适当增大)通讯录数据进行更新。
提示:
此方式为定时全量拉取企业微信通讯录数据,进行覆盖更新。可能存在同步不及时,增加服务器压力的情况。
6. 配置插件
将如上参数配置到kod钉钉插件配置中,点击[应用]进行保存——如选择同步方式为【实时推送】,保存前需先注册回调地址。
名词解释:
- 是否同步组织架构:如选择关闭,将不同步部门,只同步用户账号(部门归属默认为根部门)。
- 允许账号昵称重复:在钉钉通讯录中,可能存在用户昵称(姓名)相同的情况,如关闭该项,同名账号将无法同步。
- 允许账号自动绑定:默认关闭, 如果打算使用已有账号和钉钉账号合并, 请设置绑定唯一字段 手机号/邮箱, kod用户手机号或邮箱 和钉钉用户一致时则不会再创建新账号。
- 用户所属部门权限:用户在归属的所有部门中,都设置为这个文档权限。
- 用户在根部门权限:(点击更多展开设置) 用户在根部门(企业网盘)中的文档权限。
- 用户存储空间大小:用户个人空间分配大小。
- 部门存储空间大小:每个部门的共享空间大小。
- 用户默认权限角色:用户个人角色权限。
- 失效数据处理:此处的失效数据,主要是指已同步到kodbox系统,但在钉钉通讯录中被删除了的部门和用户。 如选择开启,同步时失效数据将被直接禁用;如选择关闭,则只对失效数据做标记,而不直接禁用,管理员可在后台【用户与部门管理】-【待处理账号】选择管理; 另,如同步方式为定时拉取,可能出现因网络或接口不稳定导致部分拉取结果为空的情况,这部分结果将被当做失效数据处理,因此建议选择关闭。
- 同步指定排除:不需要同步的部门/用户,按名称进行排除,多个时以”,”分隔。 关于排除指定部门,如待同步用户的归属部门都在排除指定范围内,则该用户也不会被同步。