Mit einem API-Schlüssel greift ein Skript auf Daten eines bestimmten Workspaces zu. Verwende für verschiedene Anwendungen getrennte Schlüssel, damit du ihren Zugriff einzeln ändern oder beenden kannst.
API-Schlüssel verwalten Eigentümer und Integratoren des Workspaces.
Schlüssel erstellen
- Wähle den gewünschten Workspace und öffne Automationen → API.
- Klicke auf API Schlüssel erstellen.
- Öffne den neuen Eintrag und gib ihm über das Stiftsymbol einen passenden Namen.
- Kopiere den Schlüssel über das Kopierfeld und hinterlege ihn in deiner Anwendung.
- Wähle Scope und Bankkonten. Speichere die Änderungen mit Speichern.
- Aktiviere den Schlüssel über den Statusschalter.
Ein neuer Schlüssel ist zunächst inaktiv. Der vollständige Wert wird beim Erstellen beziehungsweise Neugenerieren einmal bereitgestellt. Kopiere ihn, bevor du die Seite neu lädst. Später zeigt die Liste nur eine gekürzte Vorschau.
Zugriff eingrenzen
Unter Scope bestimmst du die lesbaren Daten:
- Transaktionen erlaubt den Zugriff auf Transaktionen.
- Konten erlaubt den Zugriff auf Kontodaten.
- Wenn deine Anwendung beides abruft, wähle beide Bereiche.
- Jede Funktion umfasst die derzeit verfügbaren Leseberechtigungen einschließlich Kategorien.
Unter Bankkonten wählst du einzelne Konten oder Alle Bankkonten. Die Auswahl aller Konten umfasst auch später hinzugefügte Konten. Prüfe, ob deine Anwendung das braucht.
Den wirksamen Zugriff kannst du über /key/scope abrufen. Die Antwort nennt die tatsächlichen Scopes und die Kontobeschränkung. Ein Schlüssel mit Transaktionen erhält beispielsweise transactions:read.
Schlüssel verwenden
Sende den vollständigen Schlüssel im HTTP-Header:
Authorization: Bearer DEIN_API_SCHLUESSELHinterlege den Wert serverseitig, etwa als Umgebungsvariable. Ein Schlüssel in ausgeliefertem Browser-JavaScript wäre für Besucher dieser Anwendung sichtbar.
Normale API-Schlüssel beginnen mit sk-. Für die MCP-URL erstellst du einen eigenen Schlüssel innerhalb der MCP-Integration.
Schlüssel ersetzen oder sperren
- Schlüssel neu generieren ersetzt den bisherigen Wert sofort. Kopiere den neuen Schlüssel und aktualisiere deine Anwendung. Der alte Wert funktioniert danach nicht mehr.
- Über den Statusschalter deaktivierst du einen Schlüssel vorübergehend.
- API Schlüssel löschen entfernt den Zugang dauerhaft.
Zuletzt verwendet hilft dir zu erkennen, ob eine Anwendung den Schlüssel bereits genutzt hat. Wenn du den vollständigen Schlüssel nicht mehr hast, generiere ihn neu.
Bei Zugriffsfehlern
Prüfe Workspace-Kennung, Schlüsselwert und Aktivierungsstatus. Kontrolliere anschließend Scope und Bankkontenauswahl. Für /accounts brauchst du beispielsweise eine Kontenberechtigung; eine reine Transaktionsberechtigung reicht dort nicht.