Health Check API
Aby zapewnić wszystkim użytkownikom bezproblemowe korzystanie z aplikacji, udostępniamy specjalne Health Check API. Pozwala ono programowo sprawdzić, czy dany model drzwi jest aktualnie aktywny w systemie DoorVision. Dodatkowo API wykonuje szereg kontroli stanu systemu, dzięki czemu użytkownicy zawsze widzą właściwe drzwi.
Endpoint
Ogólna kontrola stanu dla danego klienta jest dostępna pod adresem:
https://server.door-vision.com/api/v1/health/customer
Aby sprawdzić konkretny model drzwi, dołącz do endpointu jego zewnętrzne ID. Pozwala to potwierdzić, że drzwi istnieją i są aktywne w naszym systemie:
https://server.door-vision.com/api/v1/health/customer/<visualDoorExternalId>
Format odpowiedzi
API zawsze zwraca obiekt JSON z następującymi polami:
-
statusCode: kod statusu HTTP. Kod 200 oznacza pomyślną kontrolę stanu, a każdy inny kod statusu wskazuje na problem.
-
message: czytelny dla człowieka komunikat z dodatkowymi szczegółami.
-
error (opcjonalnie): komunikat o błędzie, zwracany tylko wtedy, gdy kod statusu jest inny niż 200.
Przykładowa odpowiedź (udana kontrola stanu)
Przykładowa odpowiedź (nieudana kontrola stanu)
Kod statusu HTTP w odpowiedzi wynosi 200, jeśli dla podanych parametrów (klucz klienta i zewnętrzne ID modelu drzwi) system działa prawidłowo. Każdy inny kod statusu HTTP należy traktować jako sygnał, że system nie działa prawidłowo.
Zalecenia dotyczące użycia
Health Check API pozwala ustalić, czy w sklepie internetowym marki należy wyświetlić przycisk lub link do aplikacji DoorVision. Przycisk lub link powinien być widoczny tylko wtedy, gdy Health Check API zwróci pomyślną odpowiedź (kod statusu HTTP 200), co gwarantuje, że żądany model drzwi jest dostępny i aktywny.