API Zaptec : comment s'abonner aux messages

Abonnement aux messages

*Informations extraites du document d'intégration Zaptec

Une installation peut être configurée avec un abonnement aux messages AMQP (Azure Service Bus). Les tiers peuvent se connecter aux abonnements pour recevoir des notifications push lorsque l'état de la borne de recharge change.

Les observations d'état sont des détails tels que le mode de charge, le courant de charge, l'énergie de  la session, etc. Une liste des observations fournies dans les abonnements de messagerie peut être trouvée dans le document d'intégration dans la partie State observation reference.

 

Les abonnements aux messages doivent être activés dans le Zaptec Portal au niveau de l'installation. Rendez-vous dans les paramètres avancés de l'installation et cochez l'option "Abonnement aux messages". Veuillez noter que les abonnements sont automatiquement supprimés après 14 jours sans utilisation.

L'activation d'un abonnement configurera un Topic Azure Service Bus pour votre installation. Les messages reçus des bornes de recharge de l'installation seront diffusés sur ce topic.

Il existe une large gamme d'options disponibles pour recevoir des messages à partir d'Azure Service Bus.

En plus d'utiliser les bibliothèques de Service Bus de Microsoft, il est également possible de consommer des messages en utilisant le protocole standard AMQP 1.0 détaillé ici.

 

Identifiants de connexion

Une fois l'abonnement aux messages activé, les détails de connexion peuvent être récupérés de l'une des manières suivantes :

  • Environnement de production :

Les détails de connexion peuvent être récupérés à l'aide de cette API :

https://api.zaptec.com/help/index#!/Installation/Installation_GetMessagingConnectionDetails; accessible aux utilisateurs ayant le profil Propriétaire ou Service pour l'installation.

Remarque : Étant donné que les informations d'identification et l'hôte de connexion peuvent changer à tout moment, il est important de consulter les détails de connexion de l'abonnement aux messages à partir de notre API chaque fois que vous vous connectez !

  • Environnement de développement ou de test :

Les détails de connexion peuvent être récupérés manuellement dans les paramètres d'installation avancés du Zaptec Portal ; accessibles aux utilisateurs ayant le profil Propriétaire ou Service de l'installation.

Voici un exemple de détails de connexion à l'abonnement aux messages dans le Zaptec Portal :

mceclip1.png

Les détails de connexion peuvent être combinés en tant que chaîne du Service Bus :

Endpoint=sb://{Hôte}/;SharedAccessKeyName={NomUtilisateur};SharedAccessKey={MotDePasse};EntityPath={Topic}

Les messages sont publiés sur un topic, mais ne peuvent être reçus que depuis l'abonnement au topic.

Selon la bibliothèque utilisée pour se connecter au topic du Service Bus, vous devrez peut-être combiner le nom du topic et de l'abonnement dans vos paramètres de connexion. Le nom complet des abonnements au topic est : {Topic}/subscriptions/{Subscription}

Remarque : Les abonnements aux messages seront désactivés après 14 jours sans que des messages soient envoyés à l'abonnement (par exemple, si les bornes de recharge sont hors ligne) ou sans que des messages soient consommés.

Si votre abonnement a été désactivé, vous devez le réactiver manuellement dans le Zaptec Portal ou en demandant les informations d'identification via notre API publique

http://api.zaptec.com/help/index#!/Installation/Installation_GetMessagingConnection_Details

Veuillez noter que les détails de connexion seront réinitialisés lorsque l'abonnement sera désactivé.

Remarque : La durée de vie du message est de 5 minutes. Cela signifie que toute observation d'état non consommée dans les 5 minutes sera perdue.

 

Format des messages

Les messages sont fournis sous forme d'objets ChargerState en JSON sérialisés  https://api.zaptec.com/help/index#!/Charger/Charger_ChargerState

contenant :

- ChargerId

L'UUID de la borne de recharge qui fournit le message

- StateId

L'ID de l'observation d'état modifiée - la liste des ID d'observation d'état pris en charge peut être trouvée dans le chapitre Observations d'état

- Timestamp

L'horodatage UTC de l'observation d'état modifiée, fourni sous forme de chaîne ISO 8601

- ValueAsString

La nouvelle valeur d'état, sérialisée en tant que chaîne

Boolean:true=1,false=0

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 1 sur 4