使用 Lumo 的 Public API，可以從自家系統或工具存取 Lumo 的資料，並與自有機制結合運用。本文說明 Public API 的概要，以及開始使用前的流程。詳細的實作規格，請參閱 Lumo 內的「API 文件」。
什麼是 Public API
Public API 是讓外部系統或應用程式以程式方式取得 Lumo 資料的機制。
不需透過 Lumo 的網頁畫面，即可從自家系統呼叫 Lumo 的資料。您可以將累積的資料與自家的分析平台或工具結合，協助業務自動化與提升效率。
此為工程師導向的功能。使用時需要具備以 API 進行系統開發的知識。
API 可以做什麼
Public API 可以取得聊天紀錄、發送結果與顧客資訊，並傳送 LINE 訊息、進行 ID 連結。
| 可用功能 | 內容 |
|---|---|
| 取得聊天紀錄 | 指定期間，取得LINE官方帳號與客戶往來的聊天紀錄 |
| 取得發送結果 | 取得群發訊息的清單與詳情、開啟與點擊等統計，以及每位收件人的明細 |
| 查詢顧客資訊 | 依據 LINE User ID，查詢 Lumo 上的顧客資訊 |
| 傳送訊息 | 使用自動化訊息的範本，向指定的好友傳送 LINE 訊息 |
| ID 連結 | 以自家網站的 LINE 登入為契機，將 LINE 好友與會員資訊(HubSpot聯絡人)連結起來（整合 HubSpot 時） |
您可以指定目標LINE官方帳號與取得的期間與筆數，只擷取需要的資料。可以將發送結果匯入自家的資料分析平台，也可以由自家系統的事件觸發傳送 LINE 訊息。可用功能未來也會陸續增加。
ID 連結適用於在自家會員網站等處已實作 LINE 登入的情況。將登入時取得的存取權杖交給 Lumo，該位顧客的 LINE 好友，就會與依指定的 HubSpot 聯絡人屬性比對到的會員資訊連結起來。不必額外開發畫面，就能從會員註冊接上 LINE 的後續追蹤。可在已整合 HubSpot 的 LINE官方帳號使用。
可用功能的最新列表與詳細規格，請參閱 Lumo 內的「API 文件」。
開始使用
要使用 Public API，需要在企業方案的工作區產生 API 金鑰，並在您的系統中實作呼叫 Lumo 資料的功能。
Public API 可在企業方案使用。API 金鑰是 Lumo 用來驗證來自您系統存取的鑰匙。API 金鑰的產生與管理，皆在工作區設定的 「API 金鑰」 進行。
產生 API 金鑰
在工作區設定中產生 API 金鑰。
- 開啟 「工作區設定」，選擇 「API 金鑰」
- 點擊 「產生 API 金鑰」
- 複製畫面顯示的 API 金鑰，並保存在安全的地方
API 金鑰僅在產生時顯示一次，請妥善保存在安全的地方。關閉畫面後即無法再次顯示，若遺失則需要重新產生。
整合至系統
使用產生的 API 金鑰，在您的系統中實作呼叫 Lumo 資料的功能。
請求的建立方式與可取得的資料格式等實作所需規格，可從 「查看 API 文件」 查閱。
管理 API 金鑰
已產生的 API 金鑰，可在工作區設定的 「API 金鑰」 查看與重新產生。
| 操作 | 內容 |
|---|---|
| 顯示 | 已產生的金鑰只會以開頭數個字元的遮罩形式顯示。只有在產生當下能複製完整金鑰，之後無法再顯示或複製 |
| 重新產生 | 使目前的 API 金鑰失效，並產生新的 API 金鑰 |
重新產生 API 金鑰
若遺失 API 金鑰，或金鑰可能已被第三方得知，請重新產生 API 金鑰。
- 開啟工作區設定的 「API 金鑰」
- 點擊 「重新產生」
- 在確認對話方塊中點擊 「重新產生」
重新產生後，原本的 API 金鑰將失效，且此操作無法復原。重新產生後，請在您的系統中重新設定新的 API 金鑰。
安全使用須知
API 金鑰是可以存取 Lumo 資料的鑰匙，請嚴加保管，避免被第三方得知。
- 請勿與第三方共用 API 金鑰
- 請勿將 API 金鑰直接寫入原始碼或公開的儲存庫
- 若 API 金鑰可能外洩，請立即重新產生
- API 對單位時間內的請求數設有上限，超過上限時請求會暫時受到限制
- 發送訊息時，每個請求都可以附上
Idempotency-Key標頭。用同一個金鑰重送也不會重複發送，因此連線不穩時重送也很安心
請求數上限等使用限制的詳細內容，請參閱 Lumo 內的「API 文件」。
常見問題
以下整理了 Public API 使用上的常見問題。
我遺失了 API 金鑰
API 金鑰僅在產生時顯示一次，無法再次顯示。請從工作區設定的 「API 金鑰」 重新產生。重新產生後，需要在您的系統中重新設定新的 API 金鑰。
可以取得哪些資料
可以取得聊天紀錄、群發訊息的結果（統計與每位收件人的明細），以及對應 LINE User ID 的顧客資訊。此外，也可以使用自動化訊息的範本傳送 LINE 訊息，以及以 LINE 登入為起點進行 ID 連結。可用功能未來也會陸續增加。
可以在哪些方案使用
Public API 可在企業方案使用。在其他方案中，按下 「產生 API 金鑰」 會顯示升級的說明，無法產生金鑰。方案升級可從 「設定」 > 「使用量與帳單」 進行。
哪裡可以查看詳細的實作方式
從工作區設定 「API 金鑰」 中的 「查看 API 文件」，可以查閱請求的建立方式與可取得的資料格式等實作所需規格。