API-Schlüssel

Um Verifizierungscodes zu generieren oder Verifizierungen mit der EngageLab OTP API durchzuführen, müssen Sie einen API-Schlüssel für die Basic Authentication erstellen. Sie können ihn auf der Seite "API Keys" in EngageLab OTP erstellen.

Hinweis: Jede Person oder jedes System mit Ihrem API-Schlüssel kann Ihre OTP-Servicedaten verwenden. Geben Sie ihn nicht an Dritte weiter.

Schlüssel erstellen

Wenn Sie noch keinen Schlüssel erstellt haben, klicken Sie auf "Create Now", um einen zu erstellen.

Folgen Sie den Anweisungen, um die Beschreibung des API-Schlüssels, das Ablaufdatum, die IP-Whitelist und die API-Berechtigungen einzugeben.

• Wenn das Ablaufdatum leer gelassen wird, bleibt der Schlüssel standardmäßig dauerhaft gültig.
• Die IP-Whitelist kann leer gelassen werden. Wenn sie leer ist, wird die anfragende IP nicht validiert. Nach der Konfiguration dürfen nur IPs aus der angegebenen Liste API-Anfragen senden; andernfalls lehnt das System die Anfrage ab.
• Die API-Berechtigungen steuern, ob dieser Schlüssel die "Send API" und die "Verify API" unterstützt.

Nachdem der Schlüssel erfolgreich erstellt wurde, generiert das System automatisch einen DevKey und ein DevSecret.

Klicken Sie irgendwo in die Datenzeile, um die Detailseite zu öffnen. Dort können Sie den DevKey und das DevSecret anzeigen und für Ihre Entwickler kopieren.

Schlüssel bearbeiten

Wenn Sie einen API-Schlüssel bearbeiten müssen, klicken Sie auf "Edit", um die Seite "Edit API Key" zu öffnen.

Sie können die Schlüsselbeschreibung ändern, das DevSecret zurücksetzen, das Ablaufdatum ändern, die IP-Whitelist aktualisieren und die API-Berechtigungen anpassen.

Schlüssel deaktivieren

Wenn Sie einen Schlüssel deaktivieren müssen, klicken Sie auf "Disable":

Wenn Sie den OTP-Schlüsselstatus prüfen, sehen Sie, dass sich der API-Schlüsselstatus für die EngageLab OTP-Anwendung in "Disabled" geändert hat.

Schlüssel aktivieren

Wenn Sie einen deaktivierten EngageLab OTP-Schlüssel aktivieren müssen, klicken Sie auf "Enable":

Wenn Sie den OTP-Schlüsselstatus prüfen, sehen Sie, dass sich der API-Schlüsselstatus für die EngageLab OTP-Anwendung in "Enabled" geändert hat.

Schlüssel löschen

Wenn Sie einen Schlüssel aus EngageLab OTP löschen müssen, klicken Sie auf "Delete" und bestätigen Sie erneut, um das Löschen abzuschließen.