Zum Hauptinhalt springen
Version: 5.3

REST-Server

Mit dem REST Server Plug-in können APIs zur Verfügung gestellt werden, die von außerhalb des OPC Routers zugänglich sind.

Die folgenden Eigenschaften können für den REST-Server konfiguriert werden:

NameBeliebiger Name, unter dem der REST-Server in der Verbindungsprojektierung erscheint. Wählen Sie einen Namen, der für Sie während der Verbindungsprojektierung eindeutig ist.
API über Web-Management-Endpunkt bereitstellen

Wenn diese Option aktiv ist, wird zusätzlich zum ausgewählten Port, der Port des OPC Router Web Managements genutzt, um die API bereitzustellen.
Hinweis: Die Zieladresse der API wird hierbei um das Präfix "services/{Plug-in Name}" erweitert.

Port

Der Port, unter dem die API erreichbar sein soll.

Hinweis:

  • Der Port darf nicht bereits verwendet werden.
  • Zudem ist es wichtig, den Port in der Firewall freizugeben, wenn Sie von einem anderen Gerät aus auf die API zugreifen wollen.
Routen-Präfix

Das Präfix, das nach der der IP Adresse und dem Port angegeben werden muss, um die API zu erreichen.
Beispiel:
Wenn der Routen-Präfix "/api" ist, wäre die volle URL {IP/Hosname}:{Port}/api

Sende Fehler als AntwortWenn diese Option aktiv ist, wird, wenn ein Fehler auftritt, der Status Code als Response gesendet.
Statuscode immer sendenDer Status Code wird immer gesendet z.B. bei einer erfolgreichen Übertragung.
Authentifizierung

Geben Sie an, wie man sich von außen authentifizieren muss:

  • Anonym
  • Basic
  • API sperren
Benutzername (verfügbar bei Authentifizierungsmethode Basic)Benutzername für die Anmeldung.
Passwort (verfügbar bei Authentifizierungsmethode Basic)Passwort für die Anmeldung.
SSLWenn diese Option aktiv ist, wird für die Verbindung SSL genutzt.
SSL-Zertifikat (verfügbar bei Aktivierung von SSL)Zertifikat, das für Verbindungen verwendet werden soll. Das Pluszeichen dient zum Hinzufügen eines Zertifikats, der Papierkorb zum Entfernen eines Zertifikats. Mit dem Auge können die Eigenschaften des ausgewählten Zertifikats angezeigt werden.
OpenAPI Daten bereitstellenAktivieren Sie diese Option, wenn die OpenAPI-Daten bereitgestellt werden sollen. Dies geschieht in Form einer JSON-Datei.