REST-Server

Das REST-Server-Plug-in stellt die technische Basis für REST-Endpunkte bereit, die der OPC Router selbst nach außen veröffentlicht. Die konkrete Nutzung innerhalb einer Verbindung erfolgt anschließend über den REST-Trigger.

Die Zuordnung zwischen Plug-in-Konfiguration und Trigger ist auf der Seite REST im OPC Router: Struktur und Zuständigkeiten beschrieben.

Dialogübersicht

Der Screenshot zeigt die allgemeinen Einstellungen für die Bereitstellung eigener REST-Endpunkte, zum Beispiel Port, Routen-Präfix, Authentifizierung, SSL und die Bereitstellung von OpenAPI-Daten.

Konfiguration REST-Server

Eigenschaft	Beschreibung
Name	Beliebiger Name, unter dem der REST-Server in der Verbindungsprojektierung erscheint.
API über Web-Management-Endpunkt bereitstellen	Wenn diese Option aktiv ist, wird zusätzlich zum konfigurierten Port auch der Web-Management-Endpunkt des OPC Routers für die Bereitstellung der API verwendet. Weitere Hinweise stehen im Abschnitt Bereitstellung über den Web-Management-Endpunkt.
Port	Port, unter dem die API erreichbar sein soll. Weitere Hinweise stehen im Abschnitt Port und Erreichbarkeit.
Routen-Präfix	Pfadpräfix, das hinter Host-Adresse und Port angegeben werden muss, um die API zu erreichen.
Sende Fehler als Antwort	Wenn diese Option aktiv ist, wird bei Fehlern der passende HTTP-Statuscode als Antwort zurückgegeben.
Statuscode immer senden	Sendet den HTTP-Statuscode auch bei erfolgreichen Antworten.
Authentifizierung	Legt fest, wie sich externe Clients gegenüber dem REST-Server authentifizieren müssen.
Benutzername	Benutzername für die Anmeldung bei der Authentifizierungsmethode Basic.
Passwort	Passwort für die Anmeldung bei der Authentifizierungsmethode Basic.
SSL aktivieren	Aktiviert eine TLS-gesicherte Verbindung.
SSL-Zertifikat	Zertifikat, das für die gesicherte Verbindung verwendet werden soll. Über das Pluszeichen fügen Sie ein Zertifikat hinzu, über den Papierkorb entfernen Sie es wieder. Mit dem Auge lassen sich die Eigenschaften des ausgewählten Zertifikats anzeigen. Allgemeine Informationen zum Import und zur Erstellung von Zertifikaten stehen auf den Seiten Zertifikatsverwaltung und SSL Zertifikate erstellen.
OpenAPI-Daten bereitstellen	Aktiviert die Bereitstellung der OpenAPI-Beschreibung für die konfigurierten Endpunkte als JSON-Datei. Die nachfolgenden OpenAPI-Eigenschaften sind dieser Option untergeordnet.
API-URL	Zeigt die vollständige URL des bereitgestellten REST-Endpunkts an. Die Eigenschaft ist nur verfügbar, wenn OpenAPI-Daten bereitstellen aktiviert ist.
OpenAPI-Daten-URL	Zeigt die URL zur JSON-Beschreibung der OpenAPI-Daten an. Die Eigenschaft ist nur verfügbar, wenn OpenAPI-Daten bereitstellen aktiviert ist.
OpenAPI-Daten-Oberfläche	Zeigt die URL zur Weboberfläche an, über die die bereitgestellten OpenAPI-Daten angezeigt oder getestet werden können. Die Eigenschaft ist nur verfügbar, wenn OpenAPI-Daten bereitstellen aktiviert ist.

Die OpenAPI-Eigenschaften sind hierarchisch aufgebaut: Erst wenn OpenAPI-Daten bereitstellen aktiviert ist, werden API-URL, OpenAPI-Daten-URL und OpenAPI-Daten-Oberfläche verfügbar.

Bereitstellung über den Web-Management-Endpunkt

Wenn API über Web-Management-Endpunkt bereitstellen aktiviert ist, wird zwischen Host-Adresse mit Port und dem konfigurierten Routen-Präfix zusätzlich der Pfadteil /services/{Plug-in-Name} eingefügt.

Wenn der OPC Router als Docker-Instanz betrieben wird, kann die API damit auch ohne zusätzlich exponierten REST-Port erreichbar gemacht werden, sofern der Web-Management-Endpunkt selbst bereits erreichbar ist.

hinweis

Wenn Sie diese Funktion mit Siemens Industrial Edge verwenden, muss die Client-Adresse ohne /opcrouter verwendet werden. Wird im Plug-in zum Beispiel https://172.20.10.220/opcrouter/services/MyPlugin/api angezeigt, muss der Client https://172.20.10.220/services/MyPlugin/api verwenden.

Beispiel:

• Host-Adresse und Port des Web-Management-Endpunkts: http://server:8080
• zusätzlicher Pfadteil: /services/MyPlugin
• Routen-Präfix: /api
• Ergebnis: http://server:8080/services/MyPlugin/api

Port und Erreichbarkeit

Beim konfigurierten Port ist zu beachten:

• Der Port darf nicht bereits anderweitig verwendet werden.
• Wenn Clients von anderen Geräten aus zugreifen sollen, muss der Port in der Firewall freigegeben sein.
• Wenn der OPC Router als Docker-Instanz betrieben wird, muss dieser Port zusätzlich im Container nach außen freigegeben werden.
• Wenn stattdessen API über Web-Management-Endpunkt bereitstellen aktiviert ist, kann auf die separate Freigabe des REST-Ports verzichtet werden, sofern der Web-Management-Endpunkt erreichbar ist.

Routen-Präfix

Das Routen-Präfix bestimmt den Pfadanteil hinter Host-Adresse und Port.

Beispiel:

• Host-Adresse und Port: http://server:50117
• Routen-Präfix: /api
• Ergebnis: http://server:50117/api

Authentifizierung

Für die Eigenschaft Authentifizierung stehen folgende Optionen zur Verfügung:

Option	Beschreibung
Anonym	Der Endpunkt ist ohne Anmeldung erreichbar.
Basic	Der Zugriff erfolgt über Benutzername und Passwort.
API sperren	Der REST-Endpunkt wird nicht für externe Aufrufe bereitgestellt.

Zertifikate

Allgemeine Informationen zum Import und zur Erstellung von Zertifikaten finden Sie auf den Seiten Zertifikatsverwaltung und SSL Zertifikate erstellen.

Konfiguration MCP-Server

Über das Model Context Protocol (MCP) können die bereitgestellten REST-Endpunkte zusätzlich als Werkzeuge für KI-Anwendungen veröffentlicht werden. Welche Endpunkte als MCP-Tool angeboten werden, legen Sie anschließend im REST-Trigger fest.

Eigenschaft	Beschreibung
MCP aktivieren	Aktiviert die MCP-Funktionalität für den REST-Server.
Authentifizierung	Legt fest, ob für den MCP-Endpunkt keine Authentifizierung (None) oder eine Bearer-Token-Authentifizierung (Bearer) verwendet wird.
Routen-Präfix	Pfadpräfix des MCP-Endpunkts.
Bearer Token	Token für die Authentifizierung, wenn die Bearer-Token-Authentifizierung verwendet wird.

Das Feld Bearer Token wird verwendet, wenn für Authentifizierung die Option Bearer ausgewählt ist.

Konfiguration Erweitert

Auf diesem Reiter konfigurieren Sie unter anderem CORS (Cross-Origin Resource Sharing). CORS steuert über HTTP-Antwortheader, ob ein Webbrowser Zugriffe von einer anderen Herkunft (Origin) auf den REST-Endpunkt zulässt.

Eigenschaft	Beschreibung
Legacy-Modus	Aktiviert einen Kompatibilitätsmodus für die REST-Server-Bereitstellung. Hiermit wird die Abwärtskompatibilität zu älteren OPC Router-Versionen bereitgestellt. Aktivieren Sie diese nur auf Hinweis des Supports oder wenn Probleme nach einem Update von einer älteren OPC Router-Version bestehen.
CORS-Richtlinie verwenden	Aktiviert die Konfiguration von CORS-Antwortheadern für den REST-Endpunkt.
Access-Control-Allow-Origin	Legt fest, welche Origin im Header Access-Control-Allow-Origin zurückgegeben wird.
Access-Control-Allow-Methods	Legt fest, welche HTTP-Methoden im Header Access-Control-Allow-Methods zugelassen werden.
Access-Control-Allow-Headers	Legt fest, welche HTTP-Header im Header Access-Control-Allow-Headers freigegeben werden.

Die Felder für die CORS-Header werden angezeigt, wenn CORS-Richtlinie verwenden aktiviert ist.