Développez des intégrations sécurisées reposant sur les données utilisées par les applications Eniris. Découvrez les entreprises et les appareils accessibles, gérez les relations entre les métadonnées et interrogez les données de télémétrie chronologiques provenant des actifs énergétiques connectés.
Utilisez votre compte existant. Connectez-vous à l’API d’authentification avec la même adresse e-mail et le même mot de passe que ceux utilisés pour SmartgridX ou l’application Eniris. Vous n’avez pas besoin d’identifiants API distincts.
Chaque requête API nécessite un jeton d’accès JWT. Obtenez un jeton via l’Eniris Authentication API avec ces identifiants et envoyez-le avec chaque requête :
Authorization: Bearer <access-token>
L’API utilise HTTPS et JSON. Eniris fournit également des packages client pour Python et npm qui implémentent le processus d’authentification et simplifient la communication avec l’API.
Pour consulter les schémas de requête, les modèles de réponse et l’explorateur interactif des points de terminaison actuels, utilisez la référence officielle de l’API Eniris. Privilégiez les nouveaux points de terminaison POST .../query pour lesquels la référence indique qu’un ancien point de terminaison GET a été remplacé.
L’accès à l’API est destiné aux intégrations et à l’exportation de données et peut être soumis à des frais commerciaux. Demander l’accès à l’API ou des informations tarifaires.
Le tableau suivant répertorie les champs disponibles pour lesquels des données peuvent être récupérées via l’API Eniris de requête des métadonnées et de la télémétrie.
Les données d’un champ spécifique sont disponibles uniquement pour les mesures et les politiques de conservation spécifiées.
| Nom du champ | Description | Unité de mesure | Mesure | Politique de conservation |
|---|---|---|---|---|
| actualPowerTot_W | Puissance active totale à l’instant présent. | Watt (W) |
⚠️ Pour les mesures précédentes : Valeurs positives indiquent une charge, une consommation ou une importation. Valeurs négatives indiquent une décharge ou une exportation.
⚠️ Pour ces mesures, les valeurs indiquent la production.
⚠️ Pour ces mesures, les valeurs indiquent la consommation. |
|
| childrenStoragePower_W | Puissance totale de charge ou de décharge en temps réel de toutes les batteries connectées sur un site donné. | Watt (W) | submeteringMetrics |
|
| childrenProducedPower_W | Production totale d’énergie en temps réel de tous les appareils producteurs d’énergie connectés sur un site donné. | Watt (W) | submeteringMetrics |
|
| childrenEVPower_W | Consommation totale d’énergie en temps réel de tous les chargeurs de véhicules électriques connectés sur un site donné. | Watt (W) | submeteringMetrics |
|
| childrenConsumedPower_W | Demande totale de puissance en temps réel de tous les appareils consommateurs d’énergie connectés sur un site donné. | Watt (W) | submeteringMetrics | rp_one_m |
| childrenOtherPower_W | Consommation totale d’énergie en temps réel des appareils qui ne sont ni des chargeurs de véhicules électriques ni des pompes à chaleur sur un site donné. | Watt (W) | submeteringMetrics |
|
| Nom du champ | Description | Unité de mesure | Mesure | Politique de conservation |
|---|---|---|---|---|
| importedAbsEnergyTot_Wh | Énergie totale importée | Watt-heure (Wh) |
|
|
| exportedAbsEnergyTot_Wh | Énergie totale exportée | Watt-heure (Wh) |
|
|
| producedAbsEnergyTot_Wh | Énergie totale produite | Watt-heure (Wh) |
|
|
| consumedAbsEnergyTot_Wh | Énergie totale consommée | Watt-heure (Wh) |
|
|
| chargedAbsEnergyTot_Wh | Énergie totale chargée | Watt-heure (Wh) |
|
|
| dischargedAbsEnergyTot_Wh | Énergie totale déchargée | Watt-heure (Wh) |
|
|
| importedEnergyDeltaTot_Wh | Écart d’énergie importée entre deux instants | Watt-heure (Wh) |
|
|
| exportedEnergyDeltaTot_Wh | Écart d’énergie exportée entre deux instants | Watt-heure (Wh) |
|
|
| childrenStorageChargedEnergyDeltaTot_Wh | Écart total d’énergie chargée entre deux instants pour toutes les batteries connectées sur un site donné. | Watt-heure (Wh) | submeteringMetrics |
|
| childrenStorageDischargedEnergyDeltaTot_Wh | Écart total d’énergie déchargée entre deux instants pour toutes les batteries connectées sur un site donné. | Watt-heure (Wh) | submeteringMetrics |
|
| producedEnergyDeltaTot_Wh | Écart total d’énergie produite entre deux instants | Watt-heure (Wh) |
|
|
| chargedEnergyDeltaTot_Wh | Écart d’énergie chargée entre deux instants | Watt-heure (Wh) |
|
|
| dischargedEnergyDeltaTot_Wh | Écart d’énergie déchargée entre deux instants | Watt-heure (Wh) |
|
|
| Nom du champ | Description | Unité de mesure | Mesure | Politique de conservation |
|---|---|---|---|---|
| powerSetpoint_W | Consigne de puissance commandée | Watt (W) | planning |
|
| policy | Politique de commande | - | planning |
|
| constraint_ph0_label | Libellé de la contrainte | - | planning |
|
| reactivePowerSetpoint_VAr | Consigne de puissance réactive | Voltampère réactif (VAr) | planning |
|
| Nom du champ | Description | Unité de mesure | Mesure | Politique de conservation |
|---|---|---|---|---|
| currentL1_A | Courant de la phase 1 (ligne 1) | Ampère (A) |
|
|
| currentL2_A | Courant de la phase 2 (ligne 2) | Ampère (A) |
|
|
| currentL3_A | Courant de la phase 3 (ligne 3) | Ampère (A) |
|
|
| currentN_A | Courant du neutre | Ampère (A) |
| rp_one_m |
| voltageL1N_V | Tension entre la phase 1 et le neutre (tension de phase) | Volt (V) |
|
|
| voltageL2N_V | Tension entre la phase 2 et le neutre (tension de phase) | Volt (V) |
|
|
| voltageL3N_V | Tension entre la phase 3 et le neutre (tension de phase) | Volt (V) |
|
|
| voltageL1L2_V | Tension entre lignes entre la phase 1 et la phase 2 | Volt (V) |
|
|
| voltageL2L3_V | Tension entre lignes entre la phase 2 et la phase 3 | Volt (V) |
|
|
| voltageL3L1_V | Tension entre lignes entre la phase 3 et la phase 1 | Volt (V) |
|
|
| frequency_Hz | Fréquence du système | Hertz (Hz) |
|
|
| powerFactorTot | Facteur de puissance total | - |
|
|
| powerFactorL1 | Facteur de puissance de la phase 1 | - |
| rp_one_m |
| powerFactorL2 | Facteur de puissance de la phase 2 | - |
| rp_one_m |
| powerFactorL3 | Facteur de puissance de la phase 3 | - |
| rp_one_m |
| voltageDC_V | Tension CC | Volt (V) |
|
|
| currentDC_A | Courant CC | Ampère (A) |
|
|
| status | État de l’appareil (par ex. activé, désactivé, erreur) | - |
|
|
| operationMode | Mode de fonctionnement de l’appareil | - |
|
|
| stateOfCharge_frac | État de charge (SoC) | fraction (nombre compris entre 0 et 1) |
|
|
| stateOfHealth_frac | État de santé (SoH) | fraction (nombre compris entre 0 et 1) | batteryMetrics | rp_one_m |
| childrenStorageStateOfCharge_frac | État de charge (SoC) moyen de toutes les batteries connectées sur un site donné. | fraction (nombre compris entre 0 et 1) | submeteringMetrics |
|
| batteryCurrent_A | Courant en temps réel vers ou depuis la batterie | Ampère (A) | batteryMetrics |
|
| batteryVoltage_V | Tension en temps réel de la batterie | Volt (V) | batteryMetrics |
|
| evRequiringCharge | Indique si un véhicule électrique est connecté et nécessite une recharge | Vrai ou Faux | evChargerMetrics |
|
| setpoint_W | Consigne de puissance du signal externe | Watt (W) | externalSignalMetrics |
|
| strategy | Stratégie du signal externe | - | externalSignalMetrics |
|
| signalActive | Indique si un signal externe est actif ou non | 0 ou 1 | externalSignalMetrics |
|
| reacPowerSetpoint_VAr | Consigne de puissance réactive | Voltampère réactif (VAr) | externalSignalMetrics |
|
| importLimit_W | Commande de limite de puissance importée pour un site donné. | Watt (W) | externalSignalMetrics |
|
| exportLimit_W | Commande de limite de puissance exportée pour un site donné. | Watt (W) | externalSignalMetrics |
|