Overview

The Octave partner API is a set of access points exposed via the Octave Cloud Platform, allowing Octave partners to interact with the Octave EMS.

Two interaction modes are available:

• a request/response API providing historical timelines of battery metrics and status,
• a real time event feed providing the physical measurements as they are being collected from each battery

Contact

[email protected]

Historical metrics integration over HTTP

Access pattern

This endpoint is a traditional request/response API exchanging JSON payloads over HTTP.

The scenario is initiated by the partner client application which sends a request for some metrics or status timeline and receives the corresponding data in the response payload.

OpenAPI specification

The API specification in OpenAPI format is available here:

Swagger UI

Environments URLs: production & partner integration

The partner integration environment exposes exactly the same API as production, with the same specifications and security setup. It is meant to be used by partners during the development of their client application.