Skip to main content
The HEAT Cloud API is a cloud-based REST API that provides machine-to-machine access to hybrid energy sites managed by the HEAT Energy Gateway.

​
OpenAPI

An OpenAPI specification is available here.

​
Authentication

Authentication runs over API keys that you manage on the API Settings page of the HEAT Asset Management Platform. Request access if you don’t have an account yet. The API will give you access to the same sites you can see there.

​
Obtain an API Key

Visit the API Settings page and create a new API key. After successful creation you’ll be shown an API Key ID and an API Key Secret. You should store both securely, they won’t be visible anymore later. For security reasons we recommend that you rotate keys regularly. You can revoke any key at any time, the maximum number of active keys is 20.

​
Authenticate request

Pass both the ID and the secret as a bearer token on every request:

​
Status

The current major version of the API is 1. The API version is part of the URL path, for example /api/v1/public/sites. We follow the conventions of semantic versioning. We add functionality step-by-step, contact us if you see something missing for your use-case.