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. Je eigen software leest daarmee de gegevens van een project uit en kan, waar dat kan, erop ingrijpen. Zo voed je Voltmasters-gegevens in je eigen rapportering, facturatie of gebouwbeheer.
Typische gebruikers zijn domoticasystemen, rapporteringstools en integraties op maat.
Wat de API dekt
De API werkt per project. Veel gegevens zijn beschikbaar per kwartier.
| 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 per kwartier. |
| EV-laden | De geladen energie per laadpunt per kwartier, en de laadsessies met energie, piekvermogen en laadtoestand. Je filtert op tijdvenster, laadpunt en sessiestatus; de nieuwste sessies komen eerst. |
| 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 de laadtoestand aan het begin en het einde van het kwartier. |
| Verbruik | Wat de hele site per kwartier verbruikte, opgesplitst in het deel van het net en het deel uit eigen productie. Ook de voorspelde en gemeten buitentemperatuur per uur. |
| Voorspellingen | Alle voorspellingsgegevens die het EMS gebruikt. |
| 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. |
| EMS-controller | De toestand van de controller van het project. |
De integratie-API voor partners, met webhooks, is een aparte API. Ze staat niet op deze pagina.
API-documentatie
De volledige referentie, met elk endpoint, de parameters, de vorm van de antwoorden en voorbeelden, staat hier:
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 van aanmaak. Met Verwijderen haal je een sleutel weg; een integratie die hem nog gebruikt, valt daarna stil.