Données en temps réel
Contexte
L'API Données en temps réel fournit des informations en temps réel sur vos sites — incluant l'état actuel de chaque point de recharge ainsi qu'une vue chronologique de la consommation de puissance et des limites au niveau du site. Ces données reflètent ce qui est affiché dans la vue en temps réel du tableau de bord ChargePilot.
Endpoints disponibles
GET /live/site/{id}/charging-points- Récupérer l'état actuel de tous les points de recharge d'un siteGET /live/site/{id}/power-and-limits- Récupérer les données chronologiques de puissance et de limites pour un site
GET /live/site/{id}/charging-points
Retourne l'état actuel en temps réel de chaque point de recharge du site donné, incluant l'état de branchement, l'énergie de la session active, l'état de charge et toute erreur OCPP.
Paramètres de chemin
| Paramètre | Type | Requis | Description |
|---|---|---|---|
id | string | Oui | L'identifiant du site à interroger |
Paramètres de requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
sortField | string | Non | Champ utilisé pour trier les résultats — voir Champs de tri |
sortOrder | asc | desc | Non | Sens du tri |
take | number | Non | Nombre d'enregistrements à retourner (max 100) |
skip | number | Non | Nombre d'enregistrements à ignorer, pour la pagination |
onlyCurrentlyPluggedIn | boolean | Non | Lorsque défini à true, ne retourne que les points de recharge actuellement branchés. Accepte true ou false. |
searchText | string | Non | Filtre en texte libre appliqué aux noms des points de recharge et aux noms RFID |
Réponse
json
{
"charging_points": [
/* tableau d'objets ChargingPoint */
],
"count": 12
}| Champ | Type | Description |
|---|---|---|
charging_points | array | Liste des objets de points de recharge (voir Données) |
count | number | Nombre total de points de recharge correspondants |
GET /live/site/{id}/power-and-limits
Retourne des données chronologiques pour la consommation de puissance et les limites actives au niveau du site sur la plage horaire donnée. Chaque entrée représente un intervalle de mesure, avec une ventilation par phase et la limite active à cet instant.
Paramètres de chemin
| Paramètre | Type | Requis | Description |
|---|---|---|---|
id | string | Oui | L'identifiant du site à interroger |
Paramètres de requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
from | string (ISO 8601) | Oui | Début de la plage horaire |
to | string (ISO 8601) | Oui | Fin de la plage horaire |
fuse | number | Non | Filtrer les résultats sur une valeur de fusible spécifique |
Réponse
json
[
/* tableau d'objets SitePowerAndLimits */
]Un tableau d'objets SitePowerAndLimits trié par chunk_start croissant.
Données
Champs point de recharge
| Field | Type | Required | Description |
|---|---|---|---|
id | number | Oui | Identifiant numérique interne du point de recharge |
uuid | string | Oui | UUID du point de recharge |
status | string | Oui | État actuel — voir Valeurs d'état |
name | string | Oui | Nom d'affichage du point de recharge |
prioritized | boolean | Oui | Indique si ce point de recharge bénéficie d'une priorité de charge |
charger_id | string | Oui | Identifiant de la borne de recharge parente |
device_id | string | Oui | Identifiant de l'appareil utilisé pour la communication |
ocpp_error | object | Non | Erreur OCPP active, le cas échéant — contient code (string) et vendor_code (string | null) |
rfid | string | Non | Identifiant du tag RFID de la session actuelle ou la plus récente |
rfid_name | string | Non | Nom d'affichage associé au tag RFID |
rfid_time | string (ISO 8601) | Non | Horodatage de présentation du tag RFID |
charging_power | number | Non | Puissance de charge actuelle (W) |
current_type | string | Non | AC ou DC |
inbound_power_limit | number | Non | Limite de puissance entrante active appliquée à ce point de recharge (W) |
session_energy_consumed | number | Non | Énergie consommée durant la session actuelle ou la plus récente (Wh) |
state_of_charge | number | Non | État de charge de la batterie du véhicule connecté (%) |
state_of_charge_time | string (ISO 8601) | Non | Horodatage de la dernière lecture de l'état de charge |
plug_in_time | string (ISO 8601) | Non | Horodatage du branchement du véhicule |
target_soc | number | Non | État de charge cible défini pour la session (%) |
Valeurs d'état
| Valeur | Description |
|---|---|
available | Le point de recharge est prêt et disponible |
charging | Un véhicule est en cours de charge |
error | Une erreur OCPP est active sur ce point de recharge |
finishing | La session se termine (par ex. arrêt de la transaction) |
offline | La borne de recharge n'est pas joignable |
paused_ev | La charge est en pause à cause du véhicule (par ex. batterie pleine, limite côté véhicule) |
paused_lm | La charge est en pause par la gestion de charge |
preparing | Un véhicule est connecté mais la charge n'a pas encore commencé |
unavailable | Le point de recharge a été marqué comme indisponible |
unknown | L'état ne peut pas être déterminé |
Champs de tri
Le paramètre de requête sortField accepte l'une des valeurs suivantes :
| Valeur | Description |
|---|---|
name | Trier par nom du point de recharge |
status | Trier par état actuel |
rfid_name | Trier par nom d'affichage du tag RFID |
charging_power | Trier par puissance de charge actuelle |
session_energy_consumed | Trier par énergie consommée durant la session |
state_of_charge | Trier par état de charge du véhicule |
plug_in_time | Trier par horodatage du branchement du véhicule |
Champs puissance et limites du site
Chaque objet du tableau de réponse représente un intervalle de mesure.
| Champ | Type | Requis | Description |
|---|---|---|---|
chunk_start | string (ISO 8601) | Oui | Horodatage marquant le début de cet intervalle de mesure |
total_current_phase1 | number | Oui | Courant total du site sur la phase 1 (A) |
total_current_phase2 | number | Oui | Courant total du site sur la phase 2 (A) |
total_current_phase3 | number | Oui | Courant total du site sur la phase 3 (A) |
total_power | number | Oui | Consommation de puissance totale du site (W) |
fleet_current_phase1 | number | Oui | Courant de la flotte (recharge VE) sur la phase 1 (A) |
fleet_current_phase2 | number | Oui | Courant de la flotte (recharge VE) sur la phase 2 (A) |
fleet_current_phase3 | number | Oui | Courant de la flotte (recharge VE) sur la phase 3 (A) |
fleet_power | number | Oui | Puissance totale de la flotte (recharge VE) (W) |
inbound_opt_current_limit_phase1 | number | Oui | Limite de courant entrant optimisée sur la phase 1 (A) |
inbound_opt_current_limit_phase2 | number | Oui | Limite de courant entrant optimisée sur la phase 2 (A) |
inbound_opt_current_limit_phase3 | number | Oui | Limite de courant entrant optimisée sur la phase 3 (A) |
inbound_current_limit | number | Oui | Limite de courant entrant active pour le site (A) |
power_factor_phase1 | number | Non | Facteur de puissance sur la phase 1 |
power_factor_phase2 | number | Non | Facteur de puissance sur la phase 2 |
power_factor_phase3 | number | Non | Facteur de puissance sur la phase 3 |
inbound_power_limit | number | Non | Limite de puissance entrante active pour le site (W) |
overridden_inbound_current_limit | number | Non | Valeur de surcharge manuelle pour la limite de courant entrant (A), si active |
overridden_inbound_power_limit | number | Non | Valeur de surcharge manuelle pour la limite de puissance entrante (W), si active |