Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Web Services

The program includes several web services that serve different purposes and are activated according to configuration. Certain services can be activated on demand via the following properties. The Input Web Service and the Output Web Service, on the other hand, are activated implicitly when a processing scenario includes an input system or an output system of the type "web service."

There is a globally configured base address for all program instances of xSuite Interface. The web services differ only in terms of the URL paths they use. The authentication procedure is also defined globally for all web services. Thus, if certain web services are meant to use a different base address or authentication procedure, another program instance with its own global configuration will be required for this. This program instance must differ from the other instance, at least in terms of the IP port that is being listened to.

The complete URL for calling a web service is composed of the following elements:

  • Base address (property WebService.Url[]), e.g. http://localhost:8000

  • General base path (property WebService.UrlBasePath.Url[]) (e.g., /xSuite/Interface) (optional)

  • Fixed base path of the specific service (e.g., /api/v1/Config)

  • Fixed path and, if necessary, variable parameters of the web service method (e.g., /Password/Encrypt?password=123456)

For the values in the example above, the total call would look like this:

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

The technical description of the web services according to the OpenAPI specification (Swagger) is available in JSON format and HTML format at

{base address}/{base path}/swagger/v1/swagger.json

{base address}/{base path}/swagger/index.html

In this section: