Zum Hauptinhalt springen

API-Schlüssel

API-Schlüssel geben Skripten und Integrationen langlebigen, programmatischen Zugriff auf die REST-API ohne Browsersitzung.

Einen Schlüssel erstellen​

Erstellen Sie einen Schlüssel auf zwei Arten:

  • In der App über Einstellungen → API-Schlüssel.
  • Über die API mit POST /api/v1/keys und einem name:
curl -X POST https://<your-host>/api/v1/keys \
  -H "Authorization: Bearer <session-token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "ci-export-bot" }'

Die Antwort enthält den vollständigen Schlüssel, der mit ef_live_ beginnt.

warnung

Der Schlüsselwert (ef_live_...) wird nur einmal angezeigt. EntityFlow speichert lediglich einen Hash davon — er kann nie wieder abgerufen werden. Kopieren Sie ihn sofort und bewahren Sie ihn an einem sicheren Ort auf.

Einen Schlüssel verwenden​

Senden Sie ihn als Bearer-Token bei jeder REST-Anfrage:

curl https://<your-host>/api/v1/diagrams \
  -H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"

Auflisten und widerrufen​

Sie können Schlüssel jederzeit auflisten und widerrufen, über Einstellungen → API-Schlüssel oder über die /api/v1/keys-Endpunkte. Der Widerruf eines Schlüssels wird sofort wirksam.

Berechtigungen​

Das Erstellen und Widerrufen von Schlüsseln erfordert die Berechtigung account:manage. Ein Schlüssel erbt die mandantenbezogenen Berechtigungen des Kontos, dem er gehört.