Plateforme Voltmasters

API

L’API REST publique de la plateforme Voltmasters : lisez les données d’un projet et, lorsque c’est possible, agissez dessus depuis votre propre reporting, facturation ou système de gestion technique.

La plateforme dispose d’une API REST publique. Vos propres logiciels y lisent les données d’un projet et peuvent, lorsque c’est possible, agir dessus. Vous alimentez ainsi les données Voltmasters dans votre reporting, votre facturation ou votre gestion technique.

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

Ce que couvre l’API

L’API fonctionne par projet. Beaucoup de données sont disponibles par quart d’heure.

Composant	Ce que vous pouvez lire
Appareils	Les appareils du projet, avec les identifiants que vous utilisez dans les autres appels.
Compteurs d’énergie	L’énergie prélevée et injectée par quart d’heure, ainsi que la puissance maximale de prélèvement et d’injection dans chaque quart d’heure.
Recharge EV	L’énergie chargée par point de recharge et par quart d’heure, et les sessions de recharge avec leur énergie, leur puissance de pointe et leur état de charge. Vous filtrez par fenêtre temporelle, point de recharge et statut de session ; les sessions les plus récentes viennent en premier.
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 que chaque batterie a chargée et déchargée par quart d’heure, avec l’état de charge au début et à la fin du quart d’heure.
Consommation	Ce que le site entier a consommé par quart d’heure, réparti entre la part soutirée au réseau et la part issue de sa propre production. Aussi la température extérieure prévue et mesurée par heure.
Prévisions	Toutes les données de prévision que l’EMS utilise.
Prix de l’énergie	Les prix day-ahead EPEX publiés par zone d’enchères, avec les moyennes et les chiffres de pointe et de creux. Ce point d’accès ne demande pas d’authentification.
Incidents	Les incidents du projet.
Forçages manuels	Les forçages manuels sur un appareil.
Contrôleur EMS	L’état du contrôleur du projet.

L’API d’intégration pour les partenaires, avec les webhooks, est une API distincte. Elle n’est pas traitée sur cette page.

Documentation de l’API

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

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

Vous la trouvez aussi avec le bouton Documentation API sous Paramètres → Clés API.

Créer une clé API

Vous accédez à l’API avec une clé API. Une clé s’applique à un projet et donne les droits nécessaires pour lire ou écrire les données de ce projet.

Allez dans Paramètres → Clés API.
Sous Création d’une clé API, saisissez 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 pas être récupéré ensuite.

Si vous perdez le secret, vous devez créer une nouvelle clé API et mettre à jour chaque intégration qui utilise l’ancienne.

Les clés existantes figurent sur la même page, avec leur date de création. Utilisez Supprimer pour retirer une clé ; une intégration qui l’utilise encore cesse de fonctionner.