Zum Hauptinhalt springen
Jeder Aufruf sendet den Schlüssel im Header. Die Anfrage enthält keine E-Mail und keine Organisations-ID. Organisation und Benutzer stecken im Schlüssel.
Der Schlüssel beginnt mit fyv_api_. Ein Token, der mit fyv_mcp_ oder fyv_addin_ beginnt, lehnt die API ab.

Schlüssel erzeugen

Nur ein Administrator sieht den Tab und kann Schlüssel erzeugen oder widerrufen.
  1. In Fyvel Unternehmenseinstellungen → API öffnen.
  2. Neuer API-Schlüssel wählen und einen Namen eintragen, zum Beispiel BI nächtlicher Abruf.
  3. Den Bearer-Token sofort kopieren. Er wird nur einmal angezeigt.
Ein Administrator kann bis zu fünf aktive Schlüssel haben. Ein neuer Schlüssel lässt die bestehenden gültig. Beim Wechsel einen Schlüssel einzeln widerrufen. Der Aufruf läuft mit dem Zugriff dieses Administrators. Sieht der Administrator eine Gesellschaft, sieht sie auch der Schlüssel. Der Schlüssel endet, wenn dieser Administrator die Admin-Rolle verliert oder die Organisation verlässt.

Fehler

Fehler sind JSON mit error und code. Andere Endpunkte nutzen dieselbe Form. Häufige Codes dort sind INVALID_FILTER, FORBIDDEN, REFRESH_PENDING und LOAD_FAILED.