Health Check API
To ensure a seamless experience for all users, we have implemented a dedicated Health Check API. This API allows you to programmatically verify whether a specific visual door is currently enabled in the DoorVision system. Additionally, it performs various system health checks to ensure that users always see the intended door.
Endpoint
The general health check for a customer is available at:
https://server.door-vision.com/api/v1/health/customer
To verify a specific visual door, append its external ID to the endpoint. This ensures that the door exists and is enabled in our system:
https://server.door-vision.com/api/v1/health/customer/<visualDoorExternalId>
Response Format
The API always returns a JSON object with the following fields:
-
statusCode: The HTTP status code. A 200 indicates a successful health check, while any other status code signifies an issue.
-
message: A human-readable message providing additional details.
-
error (optional): An error message included only if the status code is not 200.
Example Response (Successful Health Check)
Example Response (Unsuccessfull Health Check)
The HTTP status code in the response will be 200 if the system is healthy for the given parameters (customer key and external ID of a visual door). Any other HTTP status code should be considered an indication that the system is not healthy.
Usage Recommendation
The Health Check API can be used to determine whether a button or link to the DoorVision application should be displayed in a brand’s webshop. The button or link should only be shown if the Health Check API returns a successful response (HTTP status code 200), ensuring that the requested visual door is available and enabled.