Introduction

Our REST API is available both using our cloud entrypoint or on-site in the local network. The API's are almost identical, there are just two endpoints that are not relevant, and therefore not available, in the API on-site. These endpoints are /sites and /devices.

---

Getting Started

As the name suggests, this API is only available to Ampowr's partners and companies that work with our customers. Integrating with the API is a multi-step process, which we will go through together. We always start with a demo environment, which allows us to test the integration in a safe environment. Once we have confirmed that the integration is working as intended, we can move to the production environment, and start steering real energy assets.

API Environments (only using the cloud environment)

Our demo environment provides you with access to a demo site that is running a battery simulator and follows a predefined consumption and production data. The simulator is simulating a perfect battery, which means that it behaves slightly differently (e.g. reacting almost instantly to changes).

Once we start the integration process, we will create an isolated environment for you to play with.

Authorization

Our API is protected using API keys. At the start of the integration process, you are issued a test API key for our demo environment. Once the basic technical integration is complete, and Ampowr can confirm that the external steering is working as intended in the demo environment, you are issued a production API key. The API key is configured with fine-grained access applied, giving you only access to the sites, devices and parameters that are needed for your integration.

To successfully authorize with the API, it is required to send the API key as a request header.

GET /endpoint HTTP/1.1
X-API-Key: <your_key>