APIキー

EngageLab OTP APIを使用して認証コードを生成または検証する際には、API Basic認証キーを作成する必要があります。そのため、EngageLab OTPの「APIキー」ページで作成してください。

注意：APIキーにアクセスできる個人またはシステムは、OTPサービスデータを使用できるようになります。第三者と共有しないでください。

キーを作成する

まだキーを作成していない場合は、「今すぐ作成」をクリックして作成してください。

プロンプトに従って、APIキーの説明、有効期限、IPホワイトリスト、およびAPI権限を順に入力してください。

• 有効期限を入力しない場合、デフォルトで無期限になります。
• IPホワイトリストは空白のままにすることができます。空白の場合、リクエストIPは検証されません。設定した場合、指定されたリストにあるIPのみがAPIリクエストを送信できます。それ以外の場合、システムはリクエストを拒否します。
• API権限は、キーが「送信API」と「検証API」をサポートするかどうかを制御できます。

作成が成功すると、システムは自動的にDevKeyとDevSecretを生成します。

データの行全体をクリックして詳細ページに入り、DevKeyとDevSecretを取得して開発に使用するためにコピーしてください。

キーを編集する

APIキーを編集する必要がある場合は、「編集」をクリックしてAPIキー編集ページに入ります。

キーの説明を変更したり、DevSecretをリセットしたり、有効期限、IPホワイトリスト、API権限を変更することができます。

キーを無効化する

キーを無効化する必要がある場合は、「無効化」をクリックしてください。

この時点でOTPキーのステータスを確認すると、EngageLab OTPアプリケーションのAPIキーのステータスが「無効」に変更されたことがわかります。

キーを有効化する

無効化されたEngageLab OTPキーを有効化する必要がある場合は、「有効化」をクリックしてください。

この時点でOTPキーのステータスを確認すると、EngageLab OTPアプリケーションのAPIキーのステータスが「有効」に変更されたことがわかります。

キーを削除する

EngageLab OTPからキーを削除する必要がある場合は、「削除」をクリックし、2回確認して削除してください。