使用 Lumo 的 Public API，可以從自家系統或工具存取 Lumo 的資料，並與自有機制結合運用。本文說明 Public API 的概要，以及開始使用前的流程。詳細的實作規格，請參閱 Lumo 內的「API 文件」。
什麼是 Public API
Public API 是讓外部系統或應用程式以程式方式取得 Lumo 資料的機制。
不需透過 Lumo 的網頁畫面，即可從自家系統呼叫 Lumo 的資料。您可以將累積的資料與自家的分析平台或工具結合，協助業務自動化與提升效率。
此為工程師導向的功能。使用時需要具備以 API 進行系統開發的知識。
API 可以做什麼
目前的 Public API 可以取得 LINE 聊天的對話紀錄。
| 可用功能 | 內容 |
|---|---|
| 取得聊天紀錄 | 指定期間，取得LINE官方帳號與客戶往來的聊天紀錄 |
您可以指定目標LINE官方帳號與取得期間，只擷取需要的資料。可用功能未來將陸續增加。
可用功能的最新列表與詳細規格，請參閱 Lumo 內的「API 文件」。
開始使用
要使用 Public API，需要先產生 API 金鑰，並在您的系統中實作呼叫 Lumo 資料的功能。
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 金鑰。
安全使用須知
API 金鑰是可以存取 Lumo 資料的鑰匙，請嚴加保管，避免被第三方得知。
- 請勿與第三方共用 API 金鑰
- 請勿將 API 金鑰直接寫入原始碼或公開的儲存庫
- 若 API 金鑰可能外洩，請立即重新產生
- API 對單位時間內的請求數設有上限，超過上限時請求會暫時受到限制
請求數上限等使用限制的詳細內容，請參閱 Lumo 內的「API 文件」。
常見問題
以下整理了 Public API 使用上的常見問題。
我遺失了 API 金鑰
API 金鑰僅在產生時顯示一次，無法再次顯示。請從工作區設定的 「API 金鑰」 重新產生。重新產生後，需要在您的系統中重新設定新的 API 金鑰。
可以取得哪些資料
目前可以指定期間，取得LINE官方帳號與客戶往來的聊天紀錄。可取得的資料未來將陸續增加。
哪裡可以查看詳細的實作方式
從工作區設定 「API 金鑰」 中的 「查看 API 文件」，可以查閱請求的建立方式與可取得的資料格式等實作所需規格。