初回認証
1. 前提条件
EngageLab OTP を使用してワンタイムパスワードの生成、送信、検証を行うには、事前に以下の準備を完了しておく必要があります。
1.1 テンプレートを設定する
OTPテンプレートを作成する の手順に従って、EngageLab OTP メッセージの送信に必要なテンプレート名、テンプレートID、ブランド名、ワンタイムパスワードの長さ、有効期限、その他の情報を設定します。
1.2 APIキーを作成する
EngageLab OTP API を使用してワンタイムパスワードを生成または検証するには、API Basic Authentication キーを作成する必要があります。OTP APIキーを作成する の手順に従ってください。
2. 送信を開始する
初回の EngageLab OTP 認証メッセージを送信するには、次の2つの方法のいずれかを選択できます。
2.1 Webサイトコンソールから送信する
- 2.1.1 認証コードを生成して送信する
EngageLab Webサイトコンソール にログインし、[API Debugging] -> [OTP Send] に移動して、ページ上で created API key、target mobile number or email address、template ID、template language を順番に入力します。
上記の情報を入力した後、Send OTP Request をクリックすると、認証コードが生成され、指定した target mobile number or email address に送信されます。
リクエストが成功すると、下部の Response ボックスで、送信に使用されたレスポンスチャネルと message_id を確認できます。
リクエストが失敗した場合は、下部の Response ボックスで具体的なエラーコードとエラーメッセージを確認できます。
メッセージの送信が成功した後、履歴内のメッセージ詳細 をクリックすると、生成された one-time password と message_id を確認できます。
- 2.1.2 認証コードを検証する
EngageLab Webサイトコンソール にログインし、[API Debugging] -> [OTP Verification] に移動して、ページ上で created API key、message_id、生成された one-time password を順番に入力します。入力後、Verify OTP Request ボタンをクリックします。
2.2 API連携
コードを通じて EngageLab OTP API と連携します。詳細については、以下の2つのドキュメントを参照してください。
3. 履歴を確認する
送信に成功すると、履歴 ページでテンプレート名、送信時刻、受信者、メッセージステータス、見込み費用などの情報を確認できます。詳細は以下を参照してください：EngageLab OTP History
