Overview of the Web API Service

The 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 which are related to integrations with third-party applications. Learn more

GENESIS 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 documentation of all integrated REST APIs through Swagger.

WebAPI - Architecture

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 Web API features, the GENESIS Web API Service must be running. You can check that in Windows Services or in Workbench by selecting your project in Project Explorer and clicking Configure Services on the Home ribbon. Learn more

Notes:

^[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.