API для разработчиков

Быстрый старт#

Один запрос — и у вас состояние всех сервисов. Ответ — обычный JSON, поле updated подскажет, насколько свежие данные.

curl -s https://comfort.stream/api/v1/status

curl -s https://comfort.stream/api/v1/status/telegram

Все сервисы#

Короткое состояние каждого сервиса из каталога.

GEThttps://comfort.stream/api/v1/status

{
  "updated": 1790000000,
  "services": [
    {
      "slug": "vk",
      "name": "ВКонтакте",
      "color": "ok",
      "code": "ok",
      "live": false
    },
    {
      "slug": "telegram",
      "name": "Telegram",
      "color": "warn",
      "code": "spike",
      "live": true
    },
    {
      "slug": "sberbank",
      "name": "Сбербанк Онлайн",
      "color": "ok",
      "code": "ok",
      "live": false
    }
  ]
}

Один сервис#

Состояние одного сервиса и число жалоб за час и сутки. Вместо slug подставьте короткое имя из списка внизу страницы.

GEThttps://comfort.stream/api/v1/status/<slug>

Неизвестный slug — ответ с кодом 404.

{
  "slug": "telegram",
  "name": "Telegram",
  "color": "warn",
  "code": "spike",
  "live": true,
  "since": 1789998200,
  "reportsHour": 214,
  "reportsDay": 1387
}

Цвета и коды#

color — для светофора, code — для точной надписи. Как код звучит на сайте, видно в колонке «Надпись».

• ok — работает
• warn — есть проблемы
• bad — не работает
• none — нет данных

Значки мониторинга#

Добавьте свой сайт в мониторинг в личном кабинете — мы проверяем его каждые 5 минут из Москвы. Если включить у монитора публичную страницу, появится значок с процентом доступности: его можно вставить в README или на сайт.

GEThttps://comfort.stream/api/m/<id>/badge.svg

<a href="https://comfort.stream/m/k3f9q2x7">
  <img src="https://comfort.stream/api/m/k3f9q2x7/badge.svg" alt="uptime">
</a>

[![uptime](https://comfort.stream/api/m/k3f9q2x7/badge.svg)](https://comfort.stream/m/k3f9q2x7)

id монитора — в кабинете, в карточке сайта. Значок обновляется раз в 5 минут и работает, только пока публичная страница включена.

Правила#

1. 1Ключ не нужен. Разумный темп — не чаще раза в минуту: данные всё равно обновляются раз в 5 минут.
2. 2Ответы кешируются на минуту (Cache-Control: max-age=60): частые запросы вернут те же данные. Если с одного адреса запросов слишком много, мы можем их ограничить.
3. 3Показываете данные у себя — поставьте рядом ссылку на comfort.stream.
4. 4Данные — ориентир, а не официальная позиция сервисов. Не стройте на них решений, от которых зависят деньги или безопасность.

Список сервисов#

Нажмите на название — откроется страница статуса.