API-Keys verwalten
API-Keys für deinen persönlichen Zugriff oder für Integrationen deiner Organisation erstellen, ansehen und widerrufen.
Mit einem API-Key bindest du Drittsysteme wie Power BI, Grafana oder SAP an die ENLYZE Manufacturing Data Platform an oder schreibst eigene Skripte gegen die ENLYZE API. API-Keys verwaltest du selbst in deinen ENLYZE-Platform-Einstellungen unter app.enlyze.com/settings.
Persönliche und Organisations-API-Keys
ENLYZE unterscheidet zwei Arten von API-Keys.
Persönliche API-Keys gehören dir persönlich. Du findest sie unter Einstellungen → Konto → Persönliche API-Keys. Verlässt du die Organisation, werden alle deine persönlichen API-Keys automatisch widerrufen.
Organisations-API-Keys gehören der Organisation und sind nicht an einen individuellen Nutzer geknüpft. Organisation API-Keys können nur durch Nutzer mit der Rolle admin erstellt und verwaltet werden. Falls du ein Nutzer mit der Rolle admin bist, findest du die Organisations-API-Keys unter Einstellungen → Workspace → API-Keys.
Wann verwende ich welche Art von API-Key?
Grafana
Organisation
Power BI
Persönlich
Skript oder Notebook auf deinem Rechner
Persönlich
Produktive SAP-Integration
Organisation
Geteilte Power-BI-Berichte für ein Team
Organisation
Server-zu-Server-Integration
Organisation
Jeder API-Key gewährt vollen Zugriff auf alle Daten deiner Organisation. Es gibt keine Beschränkung auf einzelne Standorte, Maschinen oder Datenquellen. Behandle einen API-Key wie ein Passwort und teile ihn niemals.
Berechtigungen
Nicht jede Rolle darf jeden Key-Typ erstellen. Mehr zu Rollen findest du unter Nutzerverwaltung.
Admin
✅
✅
Normal
✅
❌
Operator
❌
❌
API-Key erstellen
Zur richtigen Übersicht navigieren
Für einen persönlichen API-Key: Einstellungen → Konto → Persönliche API-Keys
Für einen Organisations-API-Key: Einstellungen → Workspace → API-Keys
Der Key wird nur einmal angezeigt. Verlierst du ihn, lässt er sich nicht wiederherstellen. Erstelle in dem Fall einen neuen Key und widerrufe den alten.
API-Keys ansehen
In der Übersicht siehst du folgende Spalten:
Name
Der von dir vergebene Name
Geheimer Schlüssel
Maskierter Auszug, zum Beispiel sk_…5G08
Zuletzt verwendet
Zeitpunkt der letzten Verwendung oder Nie
Erstellt
Datum der Erstellung
Unter Konto → Persönliche API-Keys siehst du nur deine eigenen Keys. Unter Workspace → API-Keys sehen Admins alle Organisations-API-Keys der Organisation.
API-Key widerrufen
Ein widerrufener Key kann nicht reaktiviert werden. Alle Integrationen, die ihn verwenden, schlagen anschließend mit 401 Unauthorized fehl.
Öffne die passende Übersicht (Konto → Persönliche API-Keys oder Workspace → API-Keys).
Klicke in der Zeile des Keys auf das Dreipunkt-Menü.
Klicke auf Schlüssel widerrufen.
Wird ein Nutzer aus der Organisation gelöscht, werden seine persönlichen API-Keys automatisch widerrufen. Organisations-API-Keys, die er erstellt hat, bleiben aktiv. Prüfe als Admin regelmäßig die Workspace-Liste und widerrufe nicht mehr benötigte Keys.
API-Key rotieren
Eine Rotation muss manuell erfolgen. Folge hierfür diesen vier Schritten:
Erstelle einen neuen API-Key mit beschreibendem Namen.
Stelle die betroffene Integration auf den neuen Key um.
Prüfe nach ein bis zwei Tagen in der Spalte Zuletzt verwendet, ob der alte Key tatsächlich nicht mehr verwendet wird.
Widerrufe den alten Key.
Rotiere Organisations-API-Keys regelmäßig, mindestens einmal jährlich oder sobald ein Verdacht auf Kompromittierung besteht.
API-Key verwenden
Den API-Key übergibst du im HTTP-Header Authorization mit dem Schema Bearer:
Die vollständige Endpunkt-Dokumentation findest du unter app.enlyze.com/api/v2/redoc.
In den Integrationsanleitungen findest du, wo der Key konkret eingetragen wird:
FAQ
Kann ich einen verlorenen API-Key wiederherstellen?
Nein. Der Key wird aus Sicherheitsgründen nur einmal bei der Erstellung im Klartext angezeigt. Erstelle einen neuen Key und widerrufe den verlorenen.
Was passiert mit den Keys, wenn ich aus der Organisation entfernt werde?
Alle deine persönlichen API-Keys werden automatisch widerrufen. Organisations-API-Keys, die du erstellt hast, bleiben aktiv und müssen von einem Admin geprüft werden.
Warum bekomme ich 401 Unauthorized?
Mögliche Ursachen:
Der Key wurde widerrufen oder dein Nutzerkonto wurde entfernt.
Der
Bearer-Präfix oder ein Leerzeichen im Header fehlt.Der Key wurde beim Kopieren abgeschnitten.
Prüfe den Key, indem du eine einfache Anfrage gegen https://app.enlyze.com/api/v2/sites schickst.
Kann ich einen API-Key auf einzelne Maschinen oder Standorte einschränken?
Nein. Jeder API-Key liest alle Daten deiner Organisation. Wenn du Zugriff segmentieren möchtest, nutze die Berechtigungsstrukturen der konsumierenden Anwendung, etwa Dashboard-Berechtigungen in Grafana.
Was ist der Unterschied zwischen einem persönlichen und einem Organisations-API-Key?
Beide Keys gewähren denselben Zugriff. Der Unterschied liegt im Lebenszyklus: Persönliche Keys werden beim Austritt des Erstellers automatisch widerrufen, Organisations-Keys bleiben aktiv und sind für Integrationen gedacht, die Personalwechsel überdauern müssen.
Zuletzt aktualisiert