Проверка доступности эндпоинта вендора (get ping)

Обновлено 4 августа 2023

Умный дом периодически отправляет запрос на эндпоинт вендора, чтобы убедиться в его доступности. Если эндпоинт становится недоступным, пользователям блокируется возможность управлять устройствами вендора в приложении Салют, приложении СберБанк Онлайн, на SberBox, SberPortal и других устройствах с ассистентом от Сбера.

Формат запроса

Умный дом отправляет запрос на эндпоинт вендора. Заголовки см. в разделе Заголовки запросов.

GET /v1/ping

Формат ответа

Успешный ответ:

HTTP/1.1 200 OK

При возникновении ошибки нужно возвращать объект типа common error:

{
    "code": integer,
    "message": string,
    "details": list<string>
}

Пример запроса и ответа

Умный дом отправляет запрос для проверки доступности эндпоинта вендора.

Запрос:

curl -i -X GET /v1/ping HTTP/1.1 \
-H Host: example.com \
-H Content-Type: application/json \
-H Authorization: Bearer qwerty-1234-... \
-H X-Request-Id: abcd-0000-ifgh-...

Успешный ответ:

HTTP/1.1 200 OK

Ответ с ошибкой:

{
    "code": 503,
    "message": "Server unavailable",
    "details": []
}