該文檔僅面向獨立部署客戶
1.簡述
QuickAudience(以下簡稱QA)在對原服務商模式企微接入方式進行了升級,升級為企業自建應用方式接入,升級後,通過企業自建應用接入企微可獲得更多企微資料,並不受介面調用次數限制,降低企業擷取企微資料成本。
2.接入前準備
2.1資源清單
序號 | 資源名稱 | 規格 | 資源要求 | 備忘 |
1 | 次層網域 | qawecom.xxx.com | 網域名稱備案企業與企微註冊企業必須一致 | 如已有公網網域名稱,可共用,按照指定路徑進行轉寄即可 |
2 | EIP(公網IP) | 頻寬5Mbps | 次層網域指向該公網IP | 根據企微使用者量參考建議規格:
|
3 | SSL認證 | 與次層網域配套的SSL認證 |
|
2.2資訊清單
序號 | 用途 | 資訊 | 擷取方式(企微連結) |
1 | 企微帳號關聯 | corpid、secret | https://developer.work.weixin.qq.com/document/path/90665#secret |
2 | 企微介面回調 | corpid |
3.網路部署說明
3.1企微回調請求轉寄
將公網網域名稱按照路徑/restapi/thirdservice/we/com,將該路徑下請求轉寄到QA服務的IP或負載平衡地址。
3.2添加Waf訪問白名單
為保證QA產品只能在內網訪問,因此需要在Waf上配置白名單,為企微回調允許存取。
在公網網域名稱下/restapi/thirdservice/we/com請求添加白名單,只允許該路徑通過公網訪問。
4.企微後台配置說明
操作前請先參照企業微信授權配置引導文檔完成企業微信授權,以下以應用程式名稱為【測試空間】
作為樣本
4.1應用可見範圍配置
注意:如果不設定可見範圍,會導致無法從企微擷取通訊錄、粉絲等資料


4.2配置相關許可權
如果要通過API擷取客戶資訊,需要先配置應用具備擷取客戶資訊許可權,否則會導致擷取失敗
進入客戶與上下遊
如下圖所示在客戶與上下遊->客戶聯絡->客戶,綁定微信開發人員ID
說明如不綁定,會影響客戶資料的擷取。

增加可調用的介面應用
將【瓴羊QA企微應用】應用勾選
參考文檔:概述 - 文檔 - 企業微信開發人員中心

4.3配置回調API資訊
進入企微自建應用,點擊設定API接收

設定API接受

配置資訊說明
配置項 | 配置值 | 說明 |
URL | https://{domain}.com/restapi/thirdservice/we/com/inner/event/oneparty/callback/{corpid} |
樣本: https://test.lydaas.com/restapi/thirdservice/we/com/inner/event/oneparty/callback/wwb697d33134e48cfc |
Token | 隨機擷取 | 需要記錄,後續在QA上關聯企微帳號使用 |
EncodingAESKey | 隨機擷取 | 需要記錄,後續在QA上關聯企微帳號使用 |
配置回調URL時,企微會向URL發出測試請求,如果步驟3企微回調請求轉寄未配置,會儲存失敗,請先進行轉寄配置
5.其他注意事項
5.1如果分析源使用的是華為雲GaussDB,需要注意字元編碼問題【重要】
在華為雲GaussDB上建立資料庫作為QA分析源時,必須指定字元編碼為UTF8,預設字元編碼SQL_ASCII在解析企微資料的Unicode編碼時會異常報錯,導致QA調度任務失敗。
【注意】字元編碼在資料庫建立完成後不支援修改,因此必須在建立時指定。
5.2歷史資料相容與遷移(非必須)
如果您綁定了服務商模式企微帳號,會在QA內產生企微歷史資料,請務必聯絡QuickAudience售後技術人員諮詢相關遷移辦法。
5.3獨立部署環境網路示意圖
對於私人化部署客戶,QA已經部署在客戶雲環境內,拉取企微資料可以直接請求企微,符合企微安全規範,企微事件回調則需要提供公網網域名稱(公網網域名稱需要與企微中企業主體一致),能夠實現企微回調事件請求到QA服務即可。

6.常見FAQ
6.1調用企微介面返回48002
現象

企微錯誤說明

解決辦法
按照4.2企微後台配置許可權步驟進行配置
6.2手動觸發調度任務
到core容器中手動執行命令
curl --location 'http://127.0.0.1:9001/swagger/test/invoke/day/dataimport/{organizationid}/{workspaceid}/WECHAT_WECOM'其中{organizationid}/{workspaceid}分別用組織ID和空間ID代替
樣本
組織名稱:測試組織
組織ID:0a27b751-db52-4ec2-b2bc-e7b747c0bfb6
空間名稱:預設空間
空間ID:5a3e3999-fccb-43ef-b232-9cbbae053e8b
curl --location 'http://127.0.0.1:9001/swagger/test/invoke/day/dataimport/0a27b751-db52-4ec2-b2bc-e7b747c0bfb6/5a3e3999-fccb-43ef-b232-9cbbae053e8b/WECHAT_WECOM'curl --location 'http://127.0.0.1:9001/swagger/test/invoke/day/dataimport/27edd606-d875-42a1-812b-e823a2727e75/27c4853e-f2c5-44c8-866d-42488e9ef999/WECHAT_WECOM'