REST Server

REST server

The REST server plug-in can be used to provide APIs that are accessible from outside the OPC Router.

The following properties can be set for the REST Server:

Name	Any name under which the REST server will appear when creating connections or templates. Select a name that is unique for you during connection configuration.
Provide API via web management endpoint	If this option is active, the port of the OPC Router Web Management is used in addition to the selected port to provide the API. Note: The destination address of the API is extended by the prefix "services/{Plug-in Name}".
Port	The port under which the API will be. Note: The port must not already be in use. In addition, it is important to release the port in the firewall if you want to access the API from another device.
Route prefix	The prefix, which must be specified after the IP and with port in order to access the API. Example: If the route prefix is "/api", the full URL would be {IP/Hostname}:{Port}/api
Send error as response	If this option is active, the status code is sent as a response if an error occurs.
Always send status code	The status code is always sent, e.g. after a successful transmission.
Authentication	Specify how to authenticate from outside: Anonymous Basic Close API
Username (available for Basic authentication method)	Username for the login.
Password (available for Basic authentication method)	Password for the login.
SSL	If this option is active, SSL is being used for the connection.
SSL certificate (available when SSL is activated)	Certificate to be used for connections. The plus button is used to add a certificate, the delete button is used to remove a certificate. The eye button can be used to display the properties of the selected certificate.
Provide OpenAPI data	Activate this option if the OpenAPI data is to be provided. This is done in the form of a JSON file.