钉钉-观远数据连接器接入与接口授权说明

1. 概述

1.1 应用场景

使用钉钉进行组织协同、考勤、通讯录和部门管理的客户，可以通过观远数据连接器同步钉钉相关数据，用于组织管理分析、考勤分析、人员与部门看板建设。

1.2 功能简介

观远数据连接器通过钉钉开放平台接口获取数据。客户需要先在钉钉开发者后台创建企业内部应用，并准备连接器所需的授权字段，再在观远数据连接器中创建“钉钉”数据账户。

1.3 注意事项

正式对接前，请确认使用的是客户自己的钉钉企业管理员账号或具备应用管理权限的账号，并已创建用于接口对接的企业内部应用。appSecret 属于敏感信息，请妥善保管，不要在文档、聊天记录或截图中明文传播。

观远数据连接器对接“钉钉”时，需要填写以下字段：

本文档的重点是说明客户应到钉钉开发者后台的哪里获取这些字段。

2. 观远数据连接器侧准备

登录观远数据连接器平台：

https://apiconnector.guandata.com/

进入控制台后，点击左侧菜单“数据账户管理”，再点击“新增数据账户”。

3. 获取授权信息

3.1 字段获取入口

钉钉开发者后台与官方说明入口：

钉钉开发者后台：https://open-dev.dingtalk.com/
钉钉开发者百科-创建应用：https://open-dingtalk.github.io/developerpedia/docs/explore/tutorials/stream/event/go/create-app/
钉钉开放平台-基础概念：https://open.dingtalk.com/document/isvapp/basic-concepts
钉钉开放平台-应用常见问题：https://open.dingtalk.com/document/app/app-faq

准备字段时，可按下面的对应关系查看：

• 需要准备 appKey 时，进入钉钉开发者后台的企业内部应用详情页，在“应用信息”中复制 Client ID；在旧命名或部分文档中，该字段也称为 AppKey。
• 需要准备 appSecret 时，在同一应用详情页的“应用信息”中复制 Client Secret；在旧命名或部分文档中，该字段也称为 AppSecret。
• 如果当前账号看不到 AppKey 和 AppSecret，优先确认该账号是否为应用创建者，或是否已被企业主管理员授予对应应用的管理权限。

3.2 创建或进入企业内部应用

登录钉钉开发者后台后，选择需要对接的组织，进入应用开发平台。根据钉钉官方“创建应用”说明，点击顶部菜单“应用开发”，在企业内部应用中创建应用；如果已有正式用于对接的应用，也可以直接进入该应用详情页。

创建应用时，请使用正式对接所需的应用名称和应用描述。应用名称和描述应符合企业实际用途，不要使用临时测试应用承接正式数据同步。

3.3 复制 appKey 和 appSecret

应用创建完成后，进入应用详情页，在左侧导航中点击“应用信息”。钉钉官方说明中，该页面可以查看应用凭证信息，并复制保存 Client ID 和 Client Secret。部分官方页面仍使用旧字段名 AppKey 和 AppSecret，字段含义与观远连接器需要填写的 appKey、appSecret 对应。

观远连接器中字段与钉钉字段的对应关系如下：

填写前请确认：

• appKey 和 appSecret 来自同一个钉钉企业内部应用。
• 使用的是正式对接所需的应用，不要混用测试应用、历史应用或其他组织下的应用。
• 复制时不要带入多余空格或换行。
• appSecret 属于敏感信息，不要向无关人员披露。

3.4 确认应用权限

如果后续测试连接或数据同步失败，除检查 appKey、appSecret 是否复制完整外，还需要确认钉钉应用已开通连接器取数所需的接口权限，例如通讯录、部门、用户或考勤相关权限。具体权限范围以客户实际需要同步的数据和钉钉开放平台审批结果为准。

4. 连接“钉钉”数据账户

在观远数据连接器“新增数据账户”页面中，所属平台选择：

钉钉

选择后，页面会展示需要填写的字段：账户名称、appKey、appSecret。

填写说明：

填写完成后，点击“测试连接”。测试通过后，点击“确定”保存数据账户。

5. 后续数据使用

数据账户保存成功后，即可在后续数据同步或取数流程中选择该“钉钉”数据账户。如果测试连接失败，优先检查 appKey 和 appSecret 是否来自同一个正式应用，以及该应用是否已开通所需接口权限。

6. 完整流程

1. 登录钉钉开发者后台。

2. 选择需要对接的组织，进入“应用开发”。

3. 创建企业内部应用，或进入已有的正式对接应用。

4. 在应用详情页的“应用信息”中复制 Client ID / AppKey 和 Client Secret / AppSecret。

5. 登录观远数据连接器，进入“数据账户管理 > 新增数据账户”。

6. 所属平台选择“钉钉”，填写账户名称、appKey 和 appSecret。

7. 点击“测试连接”，测试通过后保存数据账户。