Skip to main content

HAP如何与飞书/Lark对接集成

飞书和Lark

Lark是飞书海外发布的版本，功能和操作都一致，和HAP平台的集成操作以及效果也完全一致，本文以飞书为例进行介绍。

集成介绍​

HAP可以在飞书中以自建应用的方式进行集成。集成后，支持直接将飞书侧的组织架构同步到HAP中，以及在飞书客户端直接打开HAP，另外也支持将应用与工作流消息推送到飞书。

HAP平台集成后，可以将单个应用安装在飞书工作台，点击图标直接进入应用或指定工作表页面。

集成步骤​

1、进入HAP组织后台​

组织管理员点击系统头像进入组织管理后台，点击第三方平台，选择飞书进入集成页面。

企业微信、钉钉、飞书、Lark只能选择一个平台对接。对接完成后如果要切换集成平台，需关闭已集成平台。如何关闭已集成平台

2、打开对接信息页面​

在打开的集成步骤页面中，点击【如何获取对接信息？】打开对接信息页面，页面不要关闭，此页面有对接时需要的信息，例如Logo、主页地址等信息。

3、登录飞书开放平台，创建应用​

飞书开发者后台地址为 https://open.feishu.cn/app ，进入开发者后台，然后点击“创建企业自建应用”。

Lark开发者后台地址为 https://open.larksuite.com/app

4、填写应用基本信息​

应用图标从第2步的打开的对接指南页面中下载。

5、进入飞书应用的详情页​

创建应用后，打开刚才创建的应用详情页。

6、在飞书应用中设置主页地址​

地址从第2步的对接指南页中获取地址

  • 1)添加应用能力，选择添加"网页应用"

  • 2)在“网页应用”中将主页地址添加桌面端主页和移动端主页

  • 3)在“安全配置”中将主页地址添加到重定向URL

7、启用机器人​

通过“应用能力” - “添加应用能力” ，添加“机器人”，用机器人功能后，在飞书的消息侧就能直接收到HAP内部的待办通知、应用消息。

8、添加需要的API权限和数据权限​

添加API接口权限​

在“开发配置”-“权限管理”中，需要添加13个接口的权限,复制下面的接口名称，逐个搜索并开通权限。

  • 获取应用信息
  • 获取通讯录基本信息
  • 获取通讯录部门组织架构信息
  • 获取部门基础信息
  • 获取部门组织架构信息
  • 获取用户组织架构信息
  • 获取用户基本信息
  • 获取用户邮箱信息
  • 获取用户受雇信息
  • 获取用户 user ID
  • 获取用户手机号
  • 以应用的身份发消息
  • 给多个用户批量发消息

配置数据权限​

设置同步的人员和部门

必须选择[与应用的可用范围一致]。

9、创建发布版本和选择可用人员范围​

飞书中的应用做了调整，都需要创建一个新版本以及确认可用人员范围。

1）应用配置完毕后，需要创建发布版本

如果是更新版本，记得版本号要增大，如1.0.0 改为1.0.1

2) 配置同步人员范围和应用可见人员范围

这里选择的人员和部门，就是在飞书中可见“HAP”应用的人员，也是同步到HAP的人员和部门。

举个例子：您公司使用飞书的是100人，使用HAP的人数是30人，那么这里就选择那30人，通过部门或指定人员来选择控制范围。

对于后续的同步，都是依据此范围。例如选择了销售部，如果飞书中有员工不在销售部了，再一次同步通讯录时，HAP系统会自动将此人办理离职，如果飞书有新的人加入了销售部，再一次同步通讯录时，HAP会自动同步创建此员工的账号或恢复账号。

如果需要配置全体人员，请从部分人员选项下勾选所有人员和部门，不要直接选择‘全体成员’

3)申请发布

每次调整过应用后，都需要创建新的版本，发布并提交给公司的飞书管理员审核。确保版本是已发布才能正常使用调整后的内容。

根据调整的内容不同，有些是自动审核通过，有些则需要管理员手动操作审核。下图是管理员手动审核的地方。

可以请管理员将此应用设置为免审核，这样我们提交发布申请后自动通过审核。

11、完善HAP中和飞书的对接信息​

将App ID和App Secret写入到下面的地方

如何获取App ID和App Secret

12、同步通讯录​

同步前必看​

从飞书的通讯录同步到HAP，是依据手机号和邮箱（优先手机号）进行匹配关联的。

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

  • 两个平台间绑定的手机号相同

  • HAP账号要在组织内

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

在手机号匹配不上时，会再按邮箱搜索匹配。

在同步前，管理员要做好及明晰以下3点：

  • 1、确定好使用HAP的飞书账号范围， 范围设置参考本文第9步。

  • 2、已经有HAP账号的且加入组织的员工，一定要让员工核对好HAP账户绑定的手机号和飞书的手机号是否一致，如果不一致，请尽快绑定或换绑保持一致，全部确认后再进行同步通讯录的操作。

  • 3、还没有HAP账户的员工，点击同步后，会自动创建一个HAP账户，账户会绑定一个随机生成的邮箱

开始同步​

组织超级管理员进入 组织管理后台 > 集成 > 第三方平台 ，点击【同步】按钮。 查看同步内容说明

13、完成集成​

进入飞书工作台，可以直接打开HAP。

消息打开方式​

完成集成后，飞书可接收HAP中应用的消息。打开消息有两种方式：独立窗口打开(通过浏览器打开)和侧边栏打开（在钉钉内右侧边栏打开）。

在HAP管理后台，进入“第三方集成”-“其他”， 可以选择消息打开的方式。

其他方式登录HAP​

飞书扫码登录​

配置了二级域名的组织，在二级域名登录页会显示飞书登录的方式，可以使用飞书APP扫码或已登录账号验证登录。

配置步骤：

  1. 在组织管理后台，配置二级域名

    例如组织下配置的二级域名为为mega，组织的二级域名地址就是mega.mingdao.com

  2. 启用“飞书扫码登录”

  3. 在飞书的对接应用中，添加重定向URL。

    在开发配置>安全设置>重定向URL中，添加回调地址。可删除其他已添加的地址。

  4. 发布新版本

    飞书内的调整要正式发布后才能生效。

  5. 以上配置完成后，在二级域名页面会显示飞书登录的按钮

通过账号密码登录HAP​

除了通过飞书直接进入HAP系统，还可以直接通过账号和密码登录HAP系统。

需对账号进行登录账号和密码的设置：

  • 1、绑定手机号

  • 2、设置密码

设置步骤

  1. 从飞书工作台进入HAP

  2. 绑定手机号并设置密码

    • 点击头像，进入账号绑定页面。

    • 输入手机号和接收到的验证码，然后设置密码。

密码设置后，您可以使用前面绑定的手机号和刚设置密码直接从HAP登录。

如何将单个应用集成到飞书工作台​

如果您希望在飞书工作台点击图标后，直接进入某个应用，或进入指定工作表，在飞书中创建一个新的自建应用即可。

必须先完成平台间的集成才能实现单应用集成

  1. 在飞书开发者后台，创建新的企业自建应用

    飞书开发者后台地址为 https://open.feishu.cn/app ，

    Lark开发者后台地址为 https://open.larksuite.com/app

  2. 添加网页应用能力

  3. 生成主页地址和重定向URL

    点此获取主页地址和重定向URL

  4. 在网页应用能力中添加生成的主页地址

  5. 在安全设置中添加生成的重定向URL

  6. 确认可用人员范围并发布版本

  7. 实现效果

常见错误​

1、提示请求非法，请联系应用开发者​

这是因为没有找到重定向地址，请参考第6步，在安全设置中配置重定向URL

2、同步通讯录时，提示错误​

如果提示接口错误，如：Object reference not set to an instance of an object.. 这是因为申请的权限接口缺少或过期，请参考第8步，重新添加需要的权限。