跳至主要内容

HAP如何與飛書對接集成

集成說明​

HAP可以在飛書中以自建應用的方式進行集成。集成後，支持直接將飛書側的組織架構同步到HAP中，以及在飛書客戶端直接打開HAP，另外也支持將應用與工作流消息推送到飛書。

集成步驟​

1、進入HAP組織後臺​

組織管理員點擊係統頭像進入組織管理後臺，點擊第三方平臺，選擇飛書進入集成頁麵。

企業微信、釘釘、飛書隻能選擇一個平臺對接，如果已經對接瞭一個，另外兩個就不再顯示瞭。如何關閉對接

2、打開對接信息頁麵​

在飛書集成頁麵，點擊【如何獲取對接信息？】打開對接信息頁麵，頁麵不要關閉，此頁麵有對接時需要的信息，例如Logo、主頁地址等信息。

3、登錄飛書開放平臺，創建應用​

飛書開放平臺地址為 (https://open.feishu.cn/app) ，進入開發者後臺，然後點擊“創建應用”。

注意：飛書和lark是兩個相互獨立的平臺。HAP僅支持和飛書的對接，請確保您登錄的應用後臺地址是 open.feishu.cn，而open.larksuite.com 是不支持對接的。

4、填寫應用基本信息​

其中應用圖標從第2步的打開的對接指南頁麵中下載。

5、進入飛書應用的詳情頁​

確定創建應用後，會先進入應用列錶，然後點擊應用名稱進入應用詳情。

6、在飛書應用中設置主頁地址​

地址從第2步的對接指南頁中獲取

  • 1)添加應用能力，選擇"網頁應用"

  • 2)在飛書應用中配置“網頁”，記得先添加

  • 3)在安全配置中配置URL

7、啓用飛書應用的機器人​

啓用機器人功能，這樣在飛書消息側就能直接收到HAP內部的流程、應用消息。

8、添加需要的API權限和數據權限​

需要添加11個接口的權限：

  • 獲取應用信息
  • 以應用身份讀取通訊錄
  • 獲取部門基礎信息
  • 獲取部門組織架構信息
  • 獲取用戶組織架構信息
  • 獲取用戶郵箱信息
  • 獲取用戶受雇信息
  • 獲取用戶 user ID
  • 獲取用戶手機號
  • 以應用的身份發消息
  • 給多個用戶批量發消息

復製上麵的接口名稱，逐個搜索後並開通權限。如下圖：

設置同步的人員和部門

必須選擇[與應用的可用範圍一緻]。

9、創建發布版本和選擇可用人員範圍​

飛書中的應用每次做瞭調整，都需要創建一個發布的新版本以及確認可用人員範圍。

10、創建發布版本和設定同步人員範圍​

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。

  • 飛書PC端

  • 飛書APP

常見問題​

1、請求非法，請聯係應用開發者​

這是因為沒有找到重定嚮地址，請參考第6步，在安全設置中配置重定嚮URL

2、同步通訊錄時，提示接口錯誤。​

這是因為申請的權限接口缺少，請參考第8步，添加需要的權限。

3、提示同步失敗​

文檔問題反饋

文檔中是否有錯彆字、內容過期、難以理解等問題？ 點此給我們反饋吧