Notifier OpenAPI specification

Description

The Notifier OpenAPI specification is a standard for describing REST-compliant application programming interfaces (API). With the OpenAPI, you can connect your user-developed app to the Notifier and access the interfaces of the Notifier even when the two apps are located on different tenants. In this way, for example, notifications can be triggered from other apps and displayed in the Notifier.

Notifications outside of the Notifier can also be accepted via the OpenAPI interface. If this is the case and the user is not registered in the Notifier, the accepted notification is marked in the Notifier with the respective email address:

163054710539.png

All available routes for the Notifier can be found in the title bar under "API Documentation" by clicking on Notifier.

Operator Cockpit

You can find additional information on how to integrate your custom-developed app into the platform here:

Procedure

To establish a connection to the Notifier via the OpenAPI, follow these steps:

  1. You can retrieve information, for example, by calling the "getTimeSeries" method.

  2. Additional routes can be found in the OpenAPI.