APIキー

EngageLab OTP APIを使用して認証コードを生成したり認証を実行したりするには、API Basic Authenticationキーを作成する必要があります。APIキーは、EngageLab OTP の "API Keys" ページで作成できます。

注意：APIキーを所持している人またはシステムは、誰でもOTPサービスのデータにアクセスできます。第三者と共有しないでください。

キーを作成する

まだキーを作成していない場合は、"Create Now" をクリックして作成します。

画面の案内に従って、APIキーの説明、有効期限、IPホワイトリスト、API権限を入力します。

• 有効期限を空欄のままにした場合、キーはデフォルトで無期限に有効になります。
• IPホワイトリストは空欄のままでも構いません。空欄の場合、リクエスト元IPの検証は行われません。設定後は、指定したリスト内のIPのみがAPIリクエストを送信でき、それ以外のIPからのリクエストはシステムによって拒否されます。
• API権限では、このキーが "Send API" および "Verify API" をサポートするかどうかを制御します。

キーの作成に成功すると、システムによって DevKey と DevSecret が自動的に生成されます。

データ行の任意の場所をクリックすると詳細ページが開き、DevKey と DevSecret を確認してコピーできます。

キーを編集する

APIキーを編集する必要がある場合は、"Edit" をクリックして Edit API Key ページを開きます。

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

キーを無効にする

キーを無効にする必要がある場合は、"Disable" をクリックします。

OTPキーのステータスを確認すると、EngageLab OTPアプリケーションのAPIキーステータスが "Disabled" に変更されていることを確認できます。

キーを有効にする

無効化されたEngageLab OTPキーを有効にする必要がある場合は、"Enable" をクリックします。

OTPキーのステータスを確認すると、EngageLab OTPアプリケーションのAPIキーステータスが "Enabled" に変更されていることを確認できます。

キーを削除する

EngageLab OTPからキーを削除する必要がある場合は、"Delete" をクリックし、確認を行うと削除が完了します。