Health Check API
Pour garantir une expérience fluide à tous les utilisateurs, nous avons mis en place une Health Check API dédiée. Cette API vous permet de vérifier par programmation si une porte donnée est actuellement activée dans le système DoorVision. Elle effectue en outre divers contrôles de l’état du système, afin que les utilisateurs voient toujours la porte prévue.
Endpoint
Le contrôle d’état général d’un client est disponible à l’adresse suivante :
https://server.door-vision.com/api/v1/health/customer
Pour vérifier une porte précise, ajoutez son ID externe à la fin de l’endpoint. Vous vérifiez ainsi que la porte existe et qu’elle est activée dans notre système :
https://server.door-vision.com/api/v1/health/customer/<visualDoorExternalId>
Format de la réponse
L’API renvoie toujours un objet JSON contenant les champs suivants :
-
statusCode : le code de statut HTTP. Un code 200 indique un contrôle réussi ; tout autre code de statut signale un problème.
-
message : un message lisible par un humain, qui fournit des informations complémentaires.
-
error (facultatif) : un message d’erreur, présent uniquement si le code de statut est différent de 200.
Exemple de réponse (contrôle d’état réussi)
Exemple de réponse (contrôle d’état échoué)
Le code de statut HTTP de la réponse est 200 si le système est opérationnel pour les paramètres fournis (clé client et ID externe d’une porte). Tout autre code de statut HTTP doit être interprété comme le signe d’un dysfonctionnement du système.
Utilisation recommandée
La Health Check API permet de déterminer si un bouton ou un lien vers l’application DoorVision doit s’afficher dans la boutique en ligne d’une marque. N’affichez ce bouton ou ce lien que si la Health Check API renvoie une réponse positive (code de statut HTTP 200) : vous avez ainsi la garantie que la porte demandée est disponible et activée.