Health Check API
Damit alle Nutzer ein reibungsloses Erlebnis haben, haben wir eine eigene Health Check API implementiert. Mit dieser API prüfen Sie programmatisch, ob eine bestimmte visuelle Tür im DoorVision-System aktuell aktiviert ist. Zusätzlich führt sie verschiedene System-Health-Checks durch, damit Nutzer immer die vorgesehene Tür sehen.
Endpoint
Der allgemeine Health Check für einen Kunden ist erreichbar unter:
https://server.door-vision.com/api/v1/health/customer
Um eine bestimmte visuelle Tür zu prüfen, hängen Sie deren externe ID an den Endpoint an. So wird sichergestellt, dass die Tür existiert und in unserem System aktiviert ist:
https://server.door-vision.com/api/v1/health/customer/<visualDoorExternalId>
Antwortformat
Die API liefert immer ein JSON-Objekt mit den folgenden Feldern:
-
statusCode: Der HTTP-Statuscode. 200 steht für einen erfolgreichen Health Check, jeder andere Statuscode weist auf ein Problem hin.
-
message: Eine menschenlesbare Meldung mit zusätzlichen Details.
-
error (optional): Eine Fehlermeldung, die nur enthalten ist, wenn der Statuscode nicht 200 ist.
Beispielantwort (erfolgreicher Health Check)
Beispielantwort (fehlgeschlagener Health Check)
Der HTTP-Statuscode der Antwort ist 200, wenn das System für die angegebenen Parameter (Customer Key und externe ID einer visuellen Tür) fehlerfrei funktioniert. Jeder andere HTTP-Statuscode ist als Hinweis darauf zu werten, dass das System nicht fehlerfrei funktioniert.
Empfehlung zur Verwendung
Mit der Health Check API können Sie bestimmen, ob im Webshop einer Marke ein Button oder Link zur DoorVision-Anwendung angezeigt werden soll. Der Button oder Link sollte nur angezeigt werden, wenn die Health Check API eine erfolgreiche Antwort (HTTP-Statuscode 200) zurückgibt. So ist sichergestellt, dass die angeforderte visuelle Tür verfügbar und aktiviert ist.