REST API

EngageLab OTP REST API を連携して利用する方法を説明します。

EngageLab OTP サービスは一連の RESTful API を提供しており、プログラムからテンプレートの作成、OTP の送信、コードの検証を行えます。

次の手順に従って、REST API を使い始めましょう。

API キーの作成

EngageLab OTP API を呼び出す前に、リクエストを認証するための API キーを生成する必要があります。

1. EngageLab コンソール にログインします。
2. OTP サブコンソールに入り、アプリケーションを選択します。
3. 左側のナビゲーションバーで API キー に移動します。
4. API キーの作成 をクリックして、新しい dev_key と dev_secret を生成します。

⚠️ 警告
dev_secret は極めて機密性の高い情報です。安全に保管し、クライアント側のコードや公開リポジトリに絶対に露出させないでください。

認証

EngageLab OTP API は HTTP Basic 認証を使用します。すべての API リクエストに Authorization ヘッダーを含める必要があります。

このヘッダーは、dev_key と dev_secret を Base64 エンコードして構築します。

              
              Authorization: Basic ${base64_auth_string}

            

${base64_auth_string} は、dev_key と dev_secret をコロン（:）で連結したものを Base64 エンコードして生成します: base64(dev_key:dev_secret)。

詳細については、認証 ガイドを参照してください。

API の呼び出し

API キーを取得し、認証機構を理解したら、API の呼び出しを開始できます。すべての API エンドポイントはベース URL https://otp.api.engagelab.cc を使用します。

連携できる主な API は次のとおりです。

• OTP 送信: EngageLab プラットフォームで検証コードを生成し、テンプレート戦略に従って送信します。
• OTP 検証: ユーザーが送信したワンタイムパスワード（検証コード）を安全に検証します。
• カスタム OTP 送信: 検証コードをご自身で生成したい場合、事前生成したコードをユーザーへ送信できます。
• カスタムメッセージ送信: カスタムテンプレートに基づいて、メッセージ内容（通知やマーケティングメッセージなど）を送信します。
• テンプレート管理: プログラムからテンプレートの作成・削除、全テンプレート一覧の取得、テンプレート詳細の確認を行います。
• コールバック設定: コールバックアドレスを設定し、セキュアな検証機構を使ってステータスレポートや通知を受信します。
• ライフサイクルステータスコールバック: 送信、配信、検証などのメッセージライフサイクルの状態に関するリアルタイムデータをコールバックで受信します。
• SMPP: SMPP プロトコルを使用し、TCP 接続を通じて効率的かつ信頼性の高いメッセージ配信とステータスレポートを実現します。