Voltmasters-platform
API
De publieke REST API van het Voltmasters-platform: lees de gegevens van een project uit en stuur waar het kan aan vanuit je eigen rapportering, facturatie of gebouwbeheersysteem.
Het platform heeft een publieke REST API, zodat je eigen software de gegevens van een project kan uitlezen en, waar dat kan, erop kan ingrijpen. Alles wat je op de dashboards ziet heeft een tegenhanger in de API, wat het de manier maakt om Voltmasters-gegevens in je eigen rapportering, facturatie of gebouwbeheersysteem te voeden.
Typische gebruikers zijn domoticasystemen, rapporteringstools en integraties op maat.
Wat de API dekt
De API werkt per project en dekt onder meer:
| Onderdeel | Wat je kan uitlezen |
|---|---|
| Toestellen | De toestellen van het project, met de identifiers die je in de andere calls gebruikt. |
| Energiemeters | De afgenomen en geïnjecteerde energie per kwartier, plus het hoogste afname- en injectievermogen binnen elk kwartier. |
| EV-laden | De geladen energie per laadpunt per kwartier, en de afzonderlijke laadsessies met hun energie, piekvermogen en laadtoestand. |
| PV Productie | De energie die elke omvormer per kwartier produceerde, en het hoogste vermogen dat hij binnen elk kwartier haalde. |
| Batterij | De energie die elke batterij per kwartier opnam en teruggaf, met haar laadtoestand aan het begin en aan het einde van het kwartier. |
| Verbruik | Wat de hele site per kwartier verbruikte, opgesplitst in het deel dat van het net kwam en het deel dat ze met haar eigen productie dekte. |
| Voorspellingen | De voorspellingen waar het EMS mee werkt. |
| Energieprijzen | De gepubliceerde EPEX day-aheadprijzen per biedzone, met gemiddelden en piek- en dalcijfers. Dit endpoint vraagt geen authenticatie. |
| Incidenten | De incidenten van het project. |
| Manuele overrides | De handmatige overrides op een toestel, en er een starten of stoppen. |
| EMS-controller | De toestand van de controller van het project. |
API-documentatie
De volledige referentie, met elk endpoint, zijn parameters, de vorm van de antwoorden en voorbeelden, staat op:
Je bereikt ze ook met de knop API-documentatie onder Instellingen → API-sleutels.
Een API-sleutel aanmaken
Toegang krijg je met een API-sleutel. Een sleutel geldt voor één project en geeft de rechten die nodig zijn om de gegevens van dat project te lezen of te schrijven.
- Ga naar Instellingen → API-sleutels.
- Geef onder API-key aanmaken een herkenbare naam in, bijvoorbeeld
Domotica-integratieofRapporteringsscript. - Klik op Sleutel aanmaken.
- Het geheim wordt maar één keer getoond, op het moment dat je het aanmaakt. Kopieer het meteen en bewaar het op een veilige plek. Het is niet opnieuw op te vragen.
Ben je het geheim kwijt, dan moet je een nieuwe API-sleutel aanmaken en elke integratie die de oude gebruikt bijwerken.
De bestaande sleutels staan op dezelfde pagina, met de datum waarop ze aangemaakt zijn. Met Verwijderen haal je een sleutel weg; elke integratie die hem nog gebruikt, valt meteen stil.