Skip to main content

Authentifizierung

Alle API-Requests brauchen einen gültigen API-Key im Authorization-Header.

API-Key erstellen

  1. Gehe im Finseo Dashboard zu Settings > API
  2. Klicke auf Create API Key
  3. Wähle einen Namen, Scopes und optional eine Beschränkung auf bestimmte Projekte
  4. Kopiere den Key sofort — er wird nur einmal angezeigt

Key verwenden

Einen Key verifizieren

GET /v1/me gibt den Account zurück, zu dem ein Key gehört. Damit prüfst du, ob ein Key gültig ist, zeigst Nutzern den verbundenen Account an und liest die Scopes des Keys aus — der Endpoint antwortet unabhängig davon, ob der Account schon Projekte hat. Genau deshalb ist er der richtige Endpoint für Integrationen und Verbindungstests.
Ein ungültiger oder widerrufener Key liefert 401 mit dem Fehlercode UNAUTHORIZED.

Scopes

API-Keys können einen oder mehrere Scopes haben:

Projekt-Beschränkungen

Du kannst einen Key optional auf bestimmte Projekte beschränken. Ein Key ohne Projekt-Beschränkung hat Zugriff auf alle Projekte deines Accounts.

Key-Sicherheit

Gib API-Keys niemals in Client-Code oder öffentlichen Repositories preis.
  • Keys werden vor der Speicherung mit SHA-256 gehasht — wir speichern niemals Klartext
  • Rotiere Keys regelmäßig und widerrufe kompromittierte Keys sofort
  • Nutze Test-Keys für die Entwicklung, Live-Keys für die Produktion