Skip to content

Partner API#

The intended audience of this section of the documentation is API partners and software developers.

Overview#

The Octave Partner API is a set of access points exposed via the Octave Cloud Platform, allowing partners to integrate with the Octave EMS. It allows our partners to access a range of metrics collected from the different assets on a site, both live and historically, and it also allows to control these different assets directly.

Positioning of the Partner API within the Octave system

Positioning of the Partner API within the Octave system

Access methods#

We provide 2 types of access with each their own characteristics. You can choose to integrate with either or both based on your specific needs and requirements.

  • Our HTTP API works in a request-response way, where you can query data. It offers historical data and live data - with a few minutes delay. You can also steer the different assets through HTTP requests.
  • Our MQTT API provides a real-time interface for receiving metrics and sending commands to the different assets on a site via MQTT.

You can find detailed information about both APIs in the sections linked above.

Access to a site can be given in a read-only or full-access manner, depending on the desired level of interaction with the assets.

Contact#

Contact us at api@octave.energy for any questions or assistance.