Overview of Web API Service

Web API Service works as a web application server based on Kestrel that proxies third-party applications and GENESIS. It provides a number of features, most of them are related to integrations with third-party applications.

Web API Service in companion with FrameWorX Server [1] provide a REST API [2] where third-party services can hook-on for integrations. Those REST APIs allow you to read and write data from/to GENESIS with HTTP(S). They also provide OAuth authentication and a documentation of all integrated REST APIs through Swagger.

By default, the GENESIS installation sets up Internet Information Service (IIS) with self-signed certificates. Although, certificates are not mandatory, it is recommended to deploy certificates created by a verified certification authority. To use all the features of Web API, the service must be running (you can check it through Windows Services or Workbench path Project Explorer > Configure Service).

[1] For the additional information regarding the Point Managers and GENESIS architecture, see Workbench Internal Architecture.
[2] Representational State Transfer (REST) is an architectural style for web applications aimed at providing resources for client applications.