API-Schlüssel verwalten

Konfiguration: DOC -> Einstellungen (Zahnrad-Symbol) -> APIs

API-Schlüssel ermöglichen den programmatischen Zugriff auf die Schnittstellen des DriveLock Enterprise Servers (DES). Sie dienen der Authentifizierung, ähnlich einer herkömmlichen Benutzeranmeldung, jedoch unter Verwendung eines Schlüssels anstelle von Benutzername und Kennwort.

Die Details zu den Schnittstellen finden Sie unter dem Reiter Dokumentation.

Arten von API-Schlüsseln

  1. Rollenbasierte Berechtigung

    • Empfohlene Nutzung für die Kontrolle und Zuweisung spezifischer Berechtigungen

    • Erstellt einen technischen Benutzer mit dem Namen des API-Schlüssels

    • Möglichkeit zur detaillierten Zuweisung von Rechten durch Rollenzuordnung

  2. Supervisor

    • Ermöglicht uneingeschränkte Aktionen ohne Limitierung durch Rechte und Rollen

    • Diese Art von API-Schlüssel ist nur in der On-Premise-Version verfügbar

  3. Verknüpften DES registrieren

    • Ermöglicht die Registrierung eines verknüpften DES

    • Nur in der Cloud-Managed-Version verfügbar

    • Keine Notwendigkeit bei vorhandenem Standard-Proxy, der WebSockets unterstützt

Mögliche Aktionen

  • Über oder können Sie einen neuen API-Schlüssel anlegen.

  • Über das Menü in der Spalte Aktion können Sie die Laufzeit eines API-Schlüssels ändern oder ihn komplett neu generieren. Wenn Sie die Laufzeit ändern, wird der aktuelle Schlüssel aktualisiert. Bei einer Neugenerierung wird ein völlig neuer Schlüssel erstellt, der unabhängig vom alten Schlüssel verwendet werden kann.

Konzeptionierung einer API

Die Handhabung einer API im DOC wird analog zu einem Konto betrachtet. Ein API-Manager benötigt daher folgende zusätzliche Rollen und Berechtigungen, um effektiv zu funktionieren:

  • Ein API-Manager kann nur die Berechtigungen weitergeben, die er selbst besitzt.

  • Die Beschränkung dient der Verhinderung einer Rechteeskalation und minimiert somit unkontrollierte Zugriffsberechtigungen und potenzielle Sicherheitsrisiken.

  • Sicherstellung, dass niemand mehr Rechte erhält als ursprünglich vorgesehen.

Bei der Ernennung zum API-Manager erhält die Person automatisch folgende Berechtigungen. Sie ermöglichen dem API-Manager eine effiziente Verwaltung und Kontrolle über die APIs und die damit verbundenen Rechte und Rollen.

  • Accounts_Manage

  • Accounts_Read

  • Permissions_Manage

  • Permissions_Read

Zum Schutz und zur Sicherheit ist es essenziell, dass der API-Manager nur Rechte weitergibt, die er selbst innehat, um ein hohes Sicherheitsniveau zu gewährleisten und Risiken zu minimieren.