Доступность API

Самая дешёвая проверка: API на связи или нет. Ключ не нужен – заголовок X-API-Key метод не читает вовсе.

Именно поэтому им удобно отделять проблему с сетью от проблемы с ключом. Молчит – дело в сети или на нашей стороне. Отвечает, а ваш следующий запрос с ключом даёт 401 – дело в ключе.

Ответ

200 – тело ответа пустое.

curl -X GET "https://example.com/health"

{  "status": "healthy",  "app": "Review Aggregator",  "environment": "production"}

Что в ответе

Поле	Что означает
`status`	Всегда `healthy`, если ответ вообще пришёл.
`app`	Название сервиса.
`environment`	Контур, который вам ответил. У `api.rewio.ru` это `production`.

Метод не проверяет ни данные, ни ваш доступ: он отвечает 200 и тогда, когда отзывы временно не читаются. Для мониторинга берите проверку чтения – она отвечает 503, когда читающие методы недоступны.

Коды ошибок общие для всего API и описаны на странице Ошибки.