API-Schlüssel

Ca. 3 Min. Lesezeit

Mit API-Schlüsseln greifen externe Anwendungen auf 2WinScada zu, ohne Benutzername und Passwort einzugeben. Die Schlüssel werden auf der Registerkarte API-Schlüssel der Seite Einstellungen > Benutzerverwaltung verwaltet. Um diese Registerkarte zu verwenden, muss die Gruppe des Benutzers die Rolle UserAdministrator haben.

Jeder Schlüssel gehört zu einem Benutzer und arbeitet mit dessen Rollen und Zugriff auf Prozessgruppen. Für einen Benutzer können mehrere Schlüssel definiert werden; so erhält jede Integration einen eigenen Schlüssel, und bei Bedarf wird nur dieser Schlüssel gelöscht.

Schlüssel werden für einen von zwei Zwecken erstellt:

• SCADA API: Für Anfragen an die REST-API. Diese Schlüssel beginnen mit 2Win- und werden im Header ApiKey der Anfrage gesendet.
• MCP-Zugriff: Für KI-Clients, die sich mit dem 2WinScada-MCP-Server verbinden. Diese Schlüssel beginnen mit 2WinMcp-.

Ein für einen Zweck erstellter Schlüssel ist für den anderen ungültig; zum Beispiel wird ein Schlüssel für MCP-Zugriff von der REST-API abgelehnt.

Die Tabelle hat folgende Spalten:

• Benutzername: Der Benutzer, dem der Schlüssel gehört.
• Schlüsselname: Der Name, der den Schlüssel bezeichnet.
• Zweck: SCADA API oder MCP-Zugriff.
• Anfragen: Die Anzahl der Anfragen, die mit dem Schlüssel innerhalb eines Zeitraums von 10 Minuten gestellt wurden.
• Maximale Anfragen: Die höchste Anzahl von Anfragen, die mit dem Schlüssel innerhalb von 10 Minuten gestellt werden dürfen. Wird diese Grenze überschritten, werden Anfragen eine Zeit lang abgelehnt. Wie der Zähler zurückgesetzt wird, beschreibt die Seite REST-API.
• Letzte Anfrage: Der Zeitpunkt der letzten Anfrage mit dem Schlüssel.

Schlüssel, die zu SystemAdmin-Konten gehören, werden nur bei Anmeldung mit einem SystemAdmin-Konto aufgelistet und können nur dann geändert werden.

Schlüssel hinzufügen

Wenn Sie oben in der Tabelle auf die Schaltfläche + klicken, öffnet sich das Fenster API-Schlüsseldefinition. Füllen Sie im Fenster folgende Felder aus:

• Benutzername: Der Benutzer, dem der Schlüssel gehören soll. Kann nach dem Speichern nicht mehr geändert werden.
• Schlüsselname: Der Name, der den Schlüssel bezeichnet, höchstens 100 Zeichen. Zwei Schlüssel desselben Benutzers dürfen nicht denselben Namen haben.
• Zweck: SCADA API oder MCP-Zugriff. Der Standardwert ist MCP-Zugriff; für die REST-API muss SCADA API gewählt werden. Kann nach dem Speichern nicht mehr geändert werden.
• Maximale Anfragen: Die höchste Anzahl von Anfragen innerhalb von 10 Minuten. Der Standardwert ist 300.

Wenn Sie auf Speichern klicken, öffnet sich das Fenster API-Schlüssel erstellt und zeigt den Schlüssel an. Der Schlüssel wird nur in diesem Fenster und nur einmal angezeigt. Kopieren Sie ihn mit der Schaltfläche Kopieren, bewahren Sie ihn an einem sicheren Ort auf und klicken Sie dann auf Gespeichert, schließen. Der Schlüssel kann später nicht erneut angezeigt werden; geht er verloren, wird ein neuer Schlüssel erstellt.

Bearbeiten und Löschen

Mit dem Stiftsymbol rechts in jeder Zeile können Schlüsselname und Maximale Anfragen des Schlüssels geändert werden. Benutzer und Zweck können nicht geändert werden.

Mit dem Papierkorbsymbol wird der Schlüssel gelöscht. Anfragen mit dem gelöschten Schlüssel werden sofort abgelehnt; dieser Vorgang kann nicht rückgängig gemacht werden.

Mit dem Feld Suchen oben in der Tabelle und mit der Filterzeile unter den Spaltenüberschriften filtern Sie die Schlüssel; die Liste kann nach Excel exportiert und mit der Aktualisierungsschaltfläche neu geladen werden.