LumoのPublic APIを使うと、自社のシステムやツールからLumoのデータにアクセスし、独自の仕組みと組み合わせて活用できます。この記事では、Public APIの概要と利用を始めるまでの流れを説明します。実装の詳細な仕様は、Lumo内の「APIドキュメント」で確認できます。
Public APIとは
Public APIは、外部のシステムやアプリケーションからLumoのデータをプログラムで取得するための仕組みです。
LumoのWeb画面を使わずに、自社のシステムからLumoのデータを呼び出せます。蓄積したデータを自社の分析基盤やツールと組み合わせ、業務の自動化や効率化に役立てられます。
エンジニア向けの機能です。利用には、APIを使ったシステム開発の知識が必要です。
APIでできること
Public APIでは、チャット履歴・配信結果・顧客情報の取得と、LINEメッセージの送信ができます。
| できること | 内容 |
|---|---|
| チャット履歴の取得 | LINE公式アカウントでお客様とやり取りしたチャットの履歴を、期間を指定して取得します |
| 配信結果の取得 | メッセージ配信の一覧・詳細と、開封やクリックなどの統計、受信者ごとの明細を取得します |
| 顧客情報の照会 | LINEのユーザーIDをもとに、Lumo上の顧客情報を照会します |
| メッセージの送信 | 指定した友だちに、自動送信メッセージのテンプレートを使ってLINEメッセージを送信します |
対象とするLINE公式アカウントや取得する期間・件数を指定して、必要なデータだけを取り出せます。配信結果を自社のデータ分析基盤に取り込んだり、自社システムのイベントをきっかけにLINEメッセージを送ったりといった連携を実現できます。利用できる機能は今後順次追加する予定です。
利用できる機能の最新の一覧と詳細な仕様は、Lumo内の「APIドキュメント」で確認できます。
利用を始めるには
Public APIを使うには、Enterpriseプランのワークスペースで、APIキーを発行してお使いのシステムに組み込みます。
Public APIはEnterpriseプランで利用できます。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のユーザーIDに対応する顧客情報を取得できます。また、自動送信メッセージのテンプレートを使ったLINEメッセージの送信もできます。利用できる機能は今後順次追加する予定です。
どのプランで利用できますか
Public APIはEnterpriseプランで利用できます。それ以外のプランでは、APIキーを発行してもAPIの呼び出しはエラーになります。プランのアップグレードは 「設定」 > 「利用と請求」 から行えます。
実装方法の詳細はどこで確認できますか
ワークスペース設定の 「APIキー」 にある 「APIドキュメントを見る」 から、リクエストの作り方や取得できるデータの形式など、実装に必要な仕様を確認できます。