この記事は、Lumo APIを利用してシステム連携を行う開発者向けの情報です。LumoのPublic APIの概要を説明します。
Public APIとは
Public APIは、外部のシステムやアプリケーションからLumoのデータにプログラムでアクセスするための仕組みです。
REST APIを通じて、Lumoに蓄積されたデータを取得できます。自社のシステムやツールとLumoを連携させることで、データの活用や業務プロセスの効率化を実現できます。
APIでできること
現在、以下のエンドポイントを提供しています。
| エンドポイント | 説明 |
|---|---|
| チャットログ取得 | 指定した期間のLINEチャット履歴を取得 |
対応エンドポイントは今後順次追加予定です。
利用を始めるには
Public APIを利用するための手順を説明します。
- ワークスペース設定画面の 「APIキー」 タブを開きます
- 「APIキーを発行」 をクリックします
- 表示されたAPIキーをコピーして安全な場所に保存します
- API仕様書を参照して実装を行います
APIキーは発行時に一度だけ表示されます。紛失した場合は再発行が必要です（再発行すると以前のキーは無効になります）。
認証方式
APIへのアクセスにはAPIキーによる認証が必要です。
| 項目 | 内容 |
|---|---|
| 認証方式 | APIキー |
| ヘッダー | X-API-Key: {APIキー} |
| レート制限 | 1,000リクエスト/分 |
API仕様書
詳細なリクエスト・レスポンスの仕様は、API仕様書で確認できます。
注意事項
APIを利用する際の注意点を説明します。
- APIキーは第三者に共有しないでください
- APIキーは発行時に一度だけ表示されます。安全な場所に保管してください
- レート制限（1,000リクエスト/分）を超えた場合、一時的にリクエストが制限されます