REST-Client
Das REST-Client-Plug-in stellt die Verbindung zu einer externen REST-Schnittstelle bereit. Es definiert die technische Grundlage für alle REST-Aufrufe, die später über das REST-Client-Transferobjekt innerhalb einer Verbindung ausgeführt werden.
Die Zuordnung zwischen Plug-in-Konfiguration und REST-Client-Transferobjekt ist im Kapitel REST im OPC Router: Struktur und Zuständigkeiten beschrieben.
Dialogübersicht
Der Screenshot zeigt die Konfiguration der allgemeinen Verbindungseinstellungen für einen externen RESTful Webservice, zum Beispiel Host-Adresse, Proxy-Verhalten, Anmeldung, Header, Cookie-Verarbeitung, Zertifikate und Zeitüberschreitung.
Konfiguration
| Eigenschaft | Beschreibung |
|---|---|
| Name | Beliebiger Name, unter dem der REST-Client in der Verbindungsprojektierung erscheint. Wählen Sie einen Namen, der die Zielanwendung eindeutig beschreibt. |
| Host-URL | Basisadresse des externen RESTful Webservice. Auf diese Adresse beziehen sich die später im Transferobjekt verwendeten Endpunkte. |
| Proxy verwenden | Aktiviert die Verwendung eines Proxy-Servers für die Verbindung zum RESTful Webservice. |
| Proxy-URL | Adresse des Proxy-Servers. Diese Eigenschaft ist relevant, wenn Proxy verwenden aktiviert ist. |
| Proxy bei lokalen Adressen umgehen | Umgeht den Proxy für lokale Adressen. Diese Eigenschaft ist relevant, wenn Proxy verwenden aktiviert ist. |
| OpenAPI-Datei | Pfad oder Adresse einer OpenAPI-Beschreibungsdatei im JSON- oder YAML-Format. Wenn eine OpenAPI-Datei hinterlegt ist, kann das Transferobjekt Endpunkte und Parameter komfortabler übernehmen. |
| Anmeldung | Legt fest, wie sich der OPC Router gegenüber dem externen RESTful Webservice anmeldet. Die verfügbaren Varianten und ihre Einsatzfälle sind im Kapitel REST-Client: Anmeldevarianten beschrieben. |
| HttpHeader | Vordefinierte HTTP-Headerinformationen, die bei Aufrufen dieser Anbindung mitgesendet werden. Damit können zum Beispiel feste Header-Werte wie Accept oder statische Autorisierungsinformationen hinterlegt werden. |
| Behandlung von Cookies | Legt fest, wie Cookies für die Plug-in-Instanz verarbeitet werden. In der gezeigten Einstellung werden Cookies automatisch aus Antworten übernommen und bei weiteren Aufrufen der Plug-in-Instanz wieder mitgesendet. |
| Timeout (s) | Zeit in Sekunden, die für Verbindungsaufbau und Antwort gewartet wird, bevor ein Fehler zurückgegeben wird. |
| Vertraute Zertifikate | Legt fest, welchen Zertifikaten bei TLS-gesicherten Verbindungen vertraut wird. Weitere Informationen stehen im Abschnitt Vertrauensmodell für Zertifikate sowie im Kapitel Zertifikatsverwaltung. |
| Zertifikat | Client-Zertifikat, das für die 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. |
Je nach ausgewählter Anmeldevariante blendet der Dialog zusätzliche Eingabefelder für die jeweilige Anmeldung ein.
Anmeldung
Für die Eigenschaft Anmeldung stehen mehrere Anmeldevarianten zur Verfügung.
Eine Übersicht mit Beschreibung und Hinweisen zur Verwendung steht im Kapitel REST-Client: Anmeldevarianten.
Vertrauensmodell für Zertifikate
Für die Eigenschaft Vertraute Zertifikate stehen folgende Optionen zur Verfügung:
| Option | Beschreibung |
|---|---|
| Alle (unsicher) | Jedes Zertifikat wird akzeptiert. Diese Einstellung ist nur für Test- und Ausnahmefälle geeignet. |
| Router | Es werden nur Zertifikate akzeptiert, die in der Zertifikatsverwaltung des OPC Routers hinterlegt sind und dort als vertraut gelten. |
| Windows | Es werden nur Zertifikate akzeptiert, die im Windows-Zertifikatsspeicher vorhanden sind. |
Allgemeine Informationen zum Import und zur Erstellung von Zertifikaten finden Sie auf den Seiten Zertifikatsverwaltung und SSL Zertifikate erstellen.
Verwendung in Verbindungen
Nach dem Anlegen des REST-Client-Plug-ins verwenden Sie diese Anbindung im REST-Client-Transferobjekt, um einen konkreten Endpunkt aufzurufen und Anfrage- sowie Antwortdaten zu verarbeiten.