Web API Supported Features

Web API works as a web application server that proxies third-party applications and GENESIS. It provides a number of features, most of them are related to integrations with third-party applications. This guide discusses each one of these Web API integrations.

Web API provides the following plugins for GENESIS 11:

  • Amazon Alexa: provides integration with Amazon Alexa API
  • Azure Communication Services: provides integration with Azure Communication Services API
  • BACnet: provides a REST interface to manage the BACnet Point Manager
  • Connected Field Service: provides a REST interface to manage Connected Field Service
  • Echo: used to check if Web API service is up and running
  • Google: provides integration with Google services API (Smart Home)
  • Nexmo: provides integration with Nexmo/Vonage SMS API
  • Notifications: manages push notifications
  • OData:deprecated service; allows to read and write data from GENESIS using OData on top of a REST API
  • Realtime: provides an ASP.NET SignalR-based publisher/subscriber application to get realtime data from memory (Redis or Azure SignalR)
  • REST: provides a set of operations like read, write, and search from Alarm Server, Alarm Historian, data points, Data Historian
  • SendGrid: provides integration with SendGrid email API
  • System Information: provides system and user information
  • Twilio: provides integration with Twilio APIs for SMS, voice and WhatsApp
  • WebHooks: receives incoming requests and publish them as Alarm messages

Web API also provides a Swagger page that describes all API calls and their related parameters. This Swagger page can be accessed with one of the following URLs provided that your browser is running on the same host where the Web API service is running:

  • http://localhost/fwxapi/swagger/index.html
  • https://localhost/fwxapi/swagger/index.html

Swagger Page

In companion with all mentioned integrations above, Web API supports authentication through OAuth 2.0 and cookies.