Rest API

Official API documentation in Swagger UI.

Our API is directly accessible when the requests are done directly to the Edge Device (Local). There is also a public API available where all requests are proxied to your Edge controller using Edge-Net.

With the API it is possible to make custom integrations with your own systems. In a nutshell, the Edge API allows for interaction with:

Grid configuration
Set External limits
Chargepoints status
Charge profiles on grids and stations
Session/transaction monitoring
Manage charge cards
Manage components like energymeters
Read Notifications
Retrieve real time and historical measurements

Local API Access

When connected to the local API you will have to use a URL in the same manner as a chargepoint would connect to Edge. Either a local static IP address has to be used, or Edge can be accessed using the MDNS name (edge.lan in most cases).

All endpoints from the API documentation have to be prefixed with the API version: /api/v1/

User Roles and Access Management

An API key is required when communicating with the API. Configuration occurs via EdgeManager by navigating to "Settings → User roles" where you can set a name and role in the API access table. A key is automatically generated. The key must be passed as header: X-API-Key:AABBCC112233

Public API

All Edge devices from version 1.24.5 and higher are also accessible using a public API. This means that the Edge API is accessible from anywhere with internet connection.

All endpoints from the API documentation have to be prefixed with the Edge device you want to reach, along with the API version: Edge/{ID}/api/v1/

User Roles and Access Management

You will have to obtain your public API key from EVC-net under settings → system-users → api-token-in. The key will have to be passed as header: X-API-Key:AABBCC112233

By default this key has READ-ONLY rights for your Edge controller.