API-Keys
Diese umfassende Verwaltungsoberfläche ermöglicht es Ihnen, API-Keys für die externe API-Nutzung anzuzeigen, zu organisieren und zu verwalten. Die Dokumentation zur externen API-Nutzung ist über die technische Dokumentation zugänglich, die nur für Super-Admins verfügbar ist.
Übersicht
Das API-Key-Modul ist Ihr zentrales System zur Verwaltung von API-Keys und deren Informationen. Die Liste zeigt alle verfügbaren API-Keys.
Achten Sie darauf, eine Bezeichnung zu wählen, die den Verwendungszweck des Keys widerspiegelt.
Die Hauptansicht listet Keys mit Steuerungselementen und Paginierung auf.
- Kopfzeile & Steuerung: API-Key erstellen, Filter, Gelöschte anzeigen
- Tabellenspalten: Name, Key, Erstellt, Erstellt von, Zuletzt verwendet, Widerrufen, Aktionen (Bearbeiten, Löschen)
- Paginierung: Aktuelle Seite, Elemente pro Seite, Gesamtanzahl Keys
API-Key-Tabelle
API-Key-Papierkorbtabelle
Funktionen
API-Key-Erstellung & -Verwaltung
- Neuen API-Key erstellen und benennen
- Vorhandenen Key bearbeiten
- Key löschen
Der API-Key wird nur während der Erstellung angezeigt und ist später nicht mehr sichtbar. Achten Sie darauf, den Key für die API-Nutzung zu kopieren und ihn nicht an öffentlich zugänglichen Orten zu speichern.
Das System verhindert nicht, dass Benutzer Einträge mit einem bereits vorhandenen Namen erstellen. Achten Sie darauf, keine Duplikate zu erstellen.
API-Key-Suche & -Filterung
- Suche nach Key-Name
- Filter zum schnellen Finden bestimmter API-Keys
- Option zum Anzeigen gelöschter Keys
Das Suchfeld erlaubt reguläre Ausdrücke (RegEx) als Suchmuster. Weitere Informationen unter Learn RegEx
API-Key-Papierkorbtabelle
- Papierkorb anzeigen
- API-Keys wiederherstellen
- API-Key endgültig löschen
Fehlerbehebung
Häufige Probleme
Kein Zugang zum API-Key-Tab im Navigationsmenü
- Berechtigungen prüfen und System-Admin kontaktieren
| Rolle | Anzeigen | Bearbeiten |
|---|---|---|
| System-Admin | ✅ | ✅ |
| Andere | ❌ | ❌ |