Skip to content

Sites

Contexte

L'API Sites fournit des endpoints pour récupérer les détails des sites, notamment vos bornes de recharge et points de recharge tels que configurés dans le tableau de bord ChargePilot.

Endpoints disponibles

  • GET /sites - Récupérer tous les sites associés à la clé d'API
  • GET /sites/{id} - Récupérer un site spécifique par son identifiant

Données

Chaque objet site contient les champs suivants :

ChampTypeDescription
idstringIdentifiant unique du site
namestringNom d'affichage du site
timezonestringFuseau horaire IANA du site (ex. Europe/Berlin)
local_controllerobjectLe contrôleur local gérant ce site
fuse_treearrayReprésentation hiérarchique de l'arbre de fusibles/gestion de charge du site

Contrôleur local

ChampTypeDescription
idstringIdentifiant unique du contrôleur local
namestringNom d'affichage du contrôleur local
serial_nostringNuméro de série matériel
device_idstringIdentifiant de l'appareil utilisé pour la communication

Arbre de fusibles

L'arbre de fusibles est une structure récursive représentant la hiérarchie électrique du site — du fusible principal jusqu'aux points de charge individuels.

ChampTypeDescription
typestringType de nœud (ex. fusible, borne de recharge, groupe de points de recharge)
parametersobjectConfiguration et limites de ce nœud
childrenarrayNœuds enfants, chacun suivant la même structure d'arbre de fusibles

Paramètres du nœud

ChampTypeDescription
namestringNom d'affichage du nœud
limitnumberLimite de courant maximale (A)
inbound_limitnumberLimite de courant entrant maximale (A)
outbound_limitnumberLimite de courant sortant maximale (A)
fallbacknumberValeur de courant de secours
pending_fallback_valuenumberValeur de secours en attente d'activation
fallback_statusstringStatut de la valeur de secours
ordernumberOrdre d'affichage/traitement parmi les nœuds frères
depthstringNiveau de profondeur dans l'arbre de fusibles
fuse_idstringIdentifiant du fusible associé
firmware_versionstringVersion du firmware du matériel du nœud
additional_commentsstringNotes en texte libre
meterobjectConfiguration du compteur attaché à ce nœud (le cas échéant)
connectorsarrayPoints de recharge attachés à ce nœud (le cas échéant)

Compteur

ChampTypeDescription
is_producerbooleanIndique si le compteur mesure un producteur d'énergie (ex. solaire)
producer_namestringNom du producteur
producer_currentnumberLecture de courant du producteur (A)
is_consumerbooleanIndique si le compteur mesure un consommateur d'énergie
consumer_namestringNom du consommateur
max_possible_currentnumberCourant maximal que le compteur peut gérer (A)
fallback_valuenumberValeur de courant de secours pour ce compteur
primary_transformer_rationumberRapport d'enroulement primaire d'un transformateur attaché
secondary_transformer_rationumberRapport d'enroulement secondaire d'un transformateur attaché

Points de recharge

ChampTypeDescription
idstringIdentifiant unique du point de recharge
namestringNom d'affichage du point de recharge
connector_idstringIdentifiant OCPP du point de recharge
charging_station_idstringIdentifiant de la borne de recharge parente
prioritynumberPriorité de charge par rapport aux autres points de recharge
charging_capabilitynumber[]Niveaux de courant de charge supportés (A)
discharge_capabilitynumber[]Niveaux de courant de décharge supportés (A), pour les points de recharge V2G