Licensed to be used in conjunction with basebox, only.
// admin
API-Schlüssel
Kurzbeschreibung
Über API-Schlüssel greifen Anwendungen programmatisch auf das REST-API von basebox zu. Als Administrator erstellen und verwalten Sie hier die Schlüssel Ihrer Organisation.
Wofür nutze ich API-Schlüssel
Mit einem API-Schlüssel können eigene Anwendungen, Skripte oder Integrationen das Sprachmodell Ihrer Organisation sicher und authentifiziert nutzen – ohne dass ein Nutzer sich manuell anmeldet. So binden Sie basebox z. B. in eigene Tools oder automatisierte Abläufe ein.
Wo finde ich die API-Schlüssel
Öffnen Sie in der Seitenleiste Administration → API-Schlüssel. Die Seite zeigt:
- eine kurze Erläuterung zur Verwaltung der Schlüssel für den Zugriff auf das REST-API
- die Schaltfläche „API-Schlüssel erstellen"
- eine Tabelle der bestehenden Schlüssel mit den Spalten Name, Erstellt (Datum/Uhrzeit) und Aktionen (Löschen per Papierkorb-Symbol)
- eine Zählung der gefundenen Schlüssel
Schritt für Schritt
Einen API-Schlüssel erstellen:
- Öffnen Sie Administration → API-Schlüssel
- Klicken Sie auf „API-Schlüssel erstellen"
- Vergeben Sie im Dialog einen aussagekräftigen Namen (z. B. den Zweck oder die anbindende Anwendung)
- Klicken Sie auf „API-Schlüssel erstellen" (oder „Abbrechen", um den Vorgang zu verwerfen)
Einen API-Schlüssel löschen:
- Suchen Sie den Schlüssel in der Tabelle
- Klicken Sie in der Spalte Aktionen auf das Papierkorb-Symbol
Der Schlüssel wird damit ungültig; Anwendungen, die ihn verwenden, verlieren den Zugriff.
Hinweise
Schlüssel sicher aufbewahren
Ein API-Schlüssel gewährt Zugriff auf das API Ihrer Organisation. Behandeln Sie ihn wie ein Passwort: Geben Sie ihn nicht weiter und speichern Sie ihn an einem sicheren Ort. Der Schlüssel wird in der Regel nur einmal bei der Erstellung angezeigt – kopieren Sie ihn sofort.
Löschen kann nicht rückgängig gemacht werden
Ein gelöschter API-Schlüssel wird sofort ungültig. Alle Anwendungen und Integrationen, die diesen Schlüssel verwenden, funktionieren danach nicht mehr. Löschen Sie einen Schlüssel nur, wenn Sie sicher sind, dass er nicht mehr benötigt wird.
Nur für Administratoren
API-Schlüssel können ausschließlich von Administratoren erstellt und verwaltet werden.
Häufige Fragen
Wofür brauche ich einen API-Schlüssel? Um eigene Anwendungen oder Integrationen sicher und authentifiziert an das REST-API von basebox anzubinden und darüber das Sprachmodell Ihrer Organisation zu nutzen.
Wer darf API-Schlüssel erstellen? Nur Administratoren Ihrer Organisation.
Was passiert, wenn ich einen Schlüssel lösche? Er wird sofort ungültig. Anwendungen, die ihn verwenden, verlieren den Zugriff.
Kann ich einen Schlüssel später wiederherstellen? Nein. Ist ein Schlüssel gelöscht, muss bei Bedarf ein neuer erstellt werden.