Dasturchilar uchun API

Tezkor boshlash#

Bitta soʻrov — va barcha xizmatlarning holati qoʻlingizda. Javob — oddiy JSON, updated maydoni maʼlumotlar qanchalik yangiligini koʻrsatadi.

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

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

Barcha xizmatlar#

Katalogdagi har bir xizmatning qisqacha holati.

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
    }
  ]
}

Bitta xizmat#

Bitta xizmat holati hamda bir soat va bir sutkalik shikoyatlar soni. slug oʻrniga sahifa pastidagi roʻyxatdan qisqa nomni qoʻying.

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

Nomaʼlum slug — 404 kodi bilan javob.

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

Ranglar va kodlar#

color — svetofor uchun, code — aniq yozuv uchun. Kod saytda qanday koʻrinishi «Yozuv» ustunida keltirilgan.

• ok — ishlayapti
• warn — muammolar bor
• bad — ishlamayapti
• none — maʼlumot yoʻq

Monitoring nishonlari#

Saytingizni shaxsiy kabinetda monitoringga qoʻshing — biz uni har 5 daqiqada Moskvadan tekshiramiz. Agar monitorda ochiq sahifa yoqilsa, ishlash foizi koʻrsatilgan nishon paydo boʻladi: uni README yoki saytga joylashtirish mumkin.

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)

Monitor id raqami — kabinetda, sayt kartasida boʻladi. Nishon har 5 daqiqada yangilanadi va faqat ochiq sahifa yoqilgan boʻlsagina ishlaydi.

Qoidalar#

1. 1Kalit kerak emas. Maqbul oraliq — daqiqasiga bir martadan koʻp emas: maʼlumotlar baribir har 5 daqiqada yangilanadi.
2. 2Javoblar bir daqiqaga keshlanadi (Cache-Control: max-age=60): tez-tez soʻrov yuborilsa, oʻsha maʼlumotlar qaytadi. Bitta manzildan soʻrovlar juda koʻp boʻlsa, ularni cheklashimiz mumkin.
3. 3Maʼlumotlarni oʻzingizda koʻrsatsangiz — yoniga comfort.stream havolasini qoʻying.
4. 4Maʼlumotlar — yoʻnaltiruvchi hisoblanadi, servislar rasmiy pozitsiyasi emas. Ular asosida pul yoki xavfsizlikka taʼsir qiluvchi qarorlar qabul qilmang.

Servislar roʻyxati#

Nom ustiga bosing — status sahifasi ochiladi.