Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Webservices

Das Programm umfasst mehrere Webservices für unterschiedliche Einsatzzwecke, die abhängig von der Konfiguration aktiviert werden. Bestimmte Services sind über die nachfolgenden Eigenschaften bedarfsweise aktivierbar. Die Aktivierung des Input-Webservices und des Output-Webservices erfolgt hingegen implizit, wenn ein Verarbeitungsszenario ein Eingabesystem oder ein Ausgabesystem vom Typ "Webservice" umfasst.

Pro Programminstanz von xSuite Interface existiert für alle aktiven Webservices eine global konfigurierte Basisadresse. Die Webservices unterscheiden sich nur im URL-Pfad. Das Authentifizierungs­verfahren wird ebenfalls für alle Webservices global definiert. Wenn somit bestimmte Webservices eine abweichende Basisadresse oder ein anderes Authentifizierungsverfahren nutzen sollen, wird dafür eine weitere Programminstanz mit einer eigenen globalen Konfiguration benötigt. Diese Programminstanz muss sich von der anderen Instanz mindestens im abgehörten IP-Port unterscheiden.

Die vollständige URL zum Aufruf eines Webservices setzt sich aus folgenden Elementen zusammen:

  • Basisadresse (Eigenschaft WebService.Url[]), z. B. http://localhost:8000

  • optionaler allgemeiner Basispfad (Eigenschaft WebService.UrlBasePath), z. B. /xSuite/Interface

  • fester Basispfad des spezifischen Services, z. B. /api/v1/Config

  • fester Pfad und ggf. variable Parameter der Webservice-Methode, z. B. /Password/Encrypt?password=123456

Für die obigen Beispielwerte sieht der Gesamtaufruf dann wie folgt aus:

http://localhost:8000/xSuite/Interface/api/v1/Config/Password/Encrypt?password=123456

Die technische Beschreibung der Webservices gemäß OpenAPI-Spezifikation (Swagger) ist im JSON-Format und HTML-Format abrufbar unter

{Basisadresse}/{Basispfad}/swagger/v1/swagger.json

{Basisadresse}/{Basispfad}/swagger/index.html

In diesem Abschnitt: