REST API

EngageLab SMS REST APIの連携方法と使い方を学びましょう。

EngageLab SMSサービスは一連のRESTful APIを提供しており、プログラムからテンプレートや署名を作成したり、SMSを送信したり、残高を照会したりできます。

REST APIの利用を開始するには、以下の手順に従ってください。

API Keyの作成

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

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

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

認証

EngageLab SMS 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 Keyを取得し、認証の仕組みを理解したら、APIの呼び出しを開始できます。すべてのAPIエンドポイントはベースURL https://smsapi.engagelab.com を使用します。

以下は、連携可能な主要なAPIです。

• SMS送信：単一または複数の対象電話番号にSMSを送信し、通知やマーケティングSMSの自動送信に対応します。
• 残高照会：EngageLab SMSアカウントの利用可能残高を、一般残高や付与残高の情報を含めてAPI経由でリアルタイムに照会します。
• テンプレート管理：プログラムからテンプレートの作成、変更、削除、全テンプレート一覧の取得、テンプレート詳細の確認を行います。
• 署名管理：プログラムから署名の作成、変更、削除、全署名一覧の取得、署名詳細の確認を行います。
• コールバックイベントリファレンス：コールバックURLを設定し、セキュアな検証メカニズムを使用してステータスレポートや通知を受信します。
• SMPP：TCP接続を介してSMPPプロトコルを使用し、効率的で信頼性の高いメッセージ配信とステータスレポートを実現します。