Eine API (Application Programming Interface) ist
eine Schnittstelle, die es ermöglicht, mit einer Webseite oder
deren Backend-Services programmgesteuert zu interagieren. Über eine
Web-API können externe Anwendungen oder Entwickler Daten von der
Webseite abrufen, bearbeiten, hinzufügen oder löschen, ohne direkt
mit der Benutzeroberfläche der Webseite interagieren zu müssen.
Wie werden die Rechte eines API Keys festgelegt?
Mit einem API Key erben Sie die Rechte des Anwenders, zu dem
der Schlüssel gehört. Der API Key repräsentiert den Benutzer im
System und hat genau die Berechtigungen, die diesem Benutzer
zugewiesen wurden. Das bedeutet:
- Rechte sind benutzerabhängig: Der API Key übernimmt
automatisch alle Rollen und Einschränkungen des jeweiligen
Benutzers.
- Keine zusätzlichen Rechte: Der API Key erweitert die
Berechtigungen nicht über die des zugehörigen Benutzers hinaus.
Empfehlung bei eingeschränkten Anforderungen
- Pseudo-User mit geringeren Rollen: Wenn Sie sicherstellen
möchten, dass der API Key nur über begrenzte Rechte verfügt,
können Sie einen dedizierten Benutzer mit minimalen Rollen und
Zugriffsrechten im System anlegen.
- Dies ist besonders sinnvoll für spezifische
Automatisierungsaufgaben oder Integrationen, bei denen nicht alle
Rechte des Hauptaccounts erforderlich sind.
Neuen API-Key erstellen
- Klicken Sie auf das „+"-Symbol neben der
API-Key-Verwaltung.
- Es können mehrere API-Keys eingerichtet werden.
- Es öffnet sich ein Dialog, in dem Sie die ID
des API Keys sowie das Geheimnis kopieren
können.
Konfiguration abschließen
- Geben Sie eine Bezeichnung für den
API-Key ein.
- Legen Sie eine Gültigkeitsdauer fest.
- Speichern Sie den neuen Key.
Wichtiger Hinweis zum Geheimnis Das Geheimnis ist
später nicht mehr einsehbar. Falls Sie es nicht mehr wissen, müssen
Sie einen neuen API-Key anlegen.
Verwaltung bestehender API-Keys
Im Bereich „Ihre aktuellen Zugriffsschlüssel"
werden alle vorhandenen API-Keys angezeigt.
API-Key bearbeiten
- Klicken Sie auf das Stift-Symbol hinter
einem Key, um die Bezeichnung oder die Gültigkeitsdauer
zu ändern.
API-Key löschen
- Klicken Sie auf das Mülltonnen-Icon, um
einen API-Key zu löschen.
Hinweis: Behandeln Sie Ihre API-Keys und
Geheimnisse stets vertraulich und geben Sie diese niemals an Dritte
weiter.