Plateforme Voltmasters

API

L’API REST publique de la plateforme Voltmasters : lire les données d’un projet et agir dessus depuis votre propre reporting, facturation ou gestion technique du bâtiment.

La plateforme dispose d’une API REST publique pour que votre propre logiciel puisse lire les données d’un projet et, là où cela s’applique, agir dessus. Tout ce que vous voyez sur les tableaux de bord a son pendant dans l’API : c’est donc la voie pour alimenter votre propre reporting, votre facturation ou votre système de gestion technique du bâtiment avec les données Voltmasters.

Les utilisateurs habituels sont des systèmes domotiques, des outils de reporting et des intégrations sur mesure.

Ce que couvre l’API

L’API est délimitée par projet et couvre notamment :

Domaine	Ce que vous pouvez lire
Appareils	Les appareils du projet, avec les identifiants à utiliser dans les autres appels.
Compteurs d’énergie	L’énergie prélevée et injectée par quart d’heure, avec la puissance de pointe en prélèvement et en injection dans chaque quart d’heure.
Recharge EV	L’énergie chargée par point de charge et par quart d’heure, et les sessions de charge individuelles avec leur énergie, leur puissance de pointe et l’état de charge.
Production PV	L’énergie produite par chaque onduleur par quart d’heure, et la puissance la plus élevée atteinte dans chaque quart d’heure.
Batterie	L’énergie absorbée et restituée par chaque batterie par quart d’heure, avec son état de charge au début et à la fin du quart d’heure.
Consommation	Ce que tout le site a consommé par quart d’heure, réparti entre la part prélevée sur le réseau et la part couverte par sa propre production.
Prévisions	Les prévisions avec lesquelles l’EMS travaille.
Prix de l’énergie	Les prix EPEX day-ahead publiés par zone de marché, avec les moyennes et les chiffres en heures pleines et creuses. Cet endpoint ne demande pas d’authentification.
Incidents	Les incidents du projet.
Forçages manuels	Les forçages manuels sur un appareil, et le démarrage ou l’arrêt de l’un d’eux.
Contrôleur EMS	L’état du contrôleur du projet.

Documentation de l’API

La référence complète, avec chaque endpoint, ses paramètres, la forme des réponses et des exemples d’usage, se trouve ici :

https://platform.voltmasters.be/docs/general/api

Vous pouvez aussi y accéder avec le bouton Documentation de l’API sous Paramètres → Clés API.

Créer une clé API

L’accès s’obtient avec une clé API. Une clé est liée à un seul projet et accorde les droits nécessaires pour lire ou écrire les données de ce projet.

Allez dans Paramètres → Clés API.
Sous Créer une clé API, indiquez un nom reconnaissable, par exemple Intégration domotique ou Script de reporting.
Cliquez sur Créer la clé.
Le secret n’est affiché qu’une seule fois, au moment de la création. Copiez-le immédiatement et conservez-le en lieu sûr. Il ne peut plus être récupéré.

Si vous perdez le secret, vous devrez créer une nouvelle clé API et mettre à jour toutes les intégrations qui utilisent l’ancienne.

Les clés existantes sont listées sur la même page avec leur date de création. Supprimer retire une clé ; toute intégration qui l’utilise encore cesse aussitôt de fonctionner.