最初のOTP
1. 前提条件
EngageLab OTPを使用して認証コードを生成、送信、検証するには、開発者は使用前に以下の準備を完了する必要があります。
1.1 テンプレートの設定
ドキュメントOTPテンプレートの作成の指示に従い、EngageLab OTPのテンプレート名、テンプレートID、ブランド名、ワンタイムパスワードの長さ、有効期限などの情報を設定してください。
1.2 APIキーの作成
EngageLab OTP APIを使用して認証コードを生成または検証する際には、API基本認証キーを作成する必要があります。ドキュメントOTP APIキーの作成の指示に従い、キーを作成してください。
2. OTPの送信
EngageLab OTP認証メッセージを送信するには、以下の2つの方法から選択できます。
2.1 ウェブサイトのバックエンドから送信
- 2.1.1 認証コードの生成と送信
EngageLabウェブサイトバックエンドにログインし、[APIデバッグ] -> [OTP送信]メニューページに移動し、以下のフィールドを入力してください:作成したAPIキー
、ターゲット電話番号またはメールアドレス
、テンプレートID
、テンプレート言語
。
上記の情報を入力した後、OTPリクエストを送信
をクリックして認証コードを生成し、指定されたターゲット電話番号またはメールアドレス
に送信します。
リクエストが成功した場合、以下のレスポンス
プロンプトボックスでチャネルとmessage_idを確認できます。
リクエストが失敗した場合、以下のレスポンス
プロンプトボックスで具体的なエラーコードとエラーメッセージを確認できます。
送信が成功した後、履歴のメッセージ詳細をクリックして生成されたワンタイムパスワード
とmessage_idを確認してください。
- 2.1.2 認証コードの検証
EngageLabウェブサイトバックエンドにログインし、[APIデバッグ] -> [OTP検証]メニューページに移動し、以下のフィールドを入力してください:作成したAPIキー
、message_id
、生成されたワンタイムパスワード
。フィールドを入力した後、OTPリクエストを検証
ボタンをクリックしてください。
2.2 API統合
コードを通じてEngageLab OTP APIを統合します。詳細については、以下の2つのドキュメントを参照してください。
3. 履歴の確認
送信が成功した後、[履歴]ページでテンプレート名、送信時間、ターゲット受信者、メッセージステータス、推定コストを確認できます。詳細な指示については、ドキュメント:EngageLab OTP履歴を参照してください。