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Даныя — арыенцір, а не афіцыйная пазіцыя сервісаў. Не прымайце на іх падставе рашэнняў, ад якіх залежаць грошы альбо бяспека.

Спіс сервісаў#

Націсніце на назву — адкрыецца старонка статусу.