The Web API (Application Programming Interface) is created using Remote Procedure-Call’s (RPC) and is hosted in a Windows Service. It can be used by any external application as an interface to system:inmation, using the HTTP or WebSocket Interface.
The Web API is also used extensively by Visual KPI to provide and update the data items displayed on the Web dashboard.
Installation & Execution
There are different ways to install the Web API service. See instructions here.
The Swagger documentation can be viewed in a Web Browser by visiting:
The Web API endpoints can be tested using Postman. Download Postman here.
The Web API supports token authentication based on Profiles in the Access Model and Windows domain and local accounts. More detailed information can be found here.
HTTPS - WSS
Both interface can have encryption with TLS/SSL. See instructions here.