API Документация

Интегрируйте мониторинг сбоев в свои системы через REST API

Base URL

https://api.sboit.rf/v1

Аутентификация

Все запросы должны содержать заголовок Authorization с вашим API ключом:

curl -H "Authorization: Bearer sk_live_your_api_key" \
     https://api.sboit.rf/v1/services

GET

/services

Получить список всех сервисов

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

fetch('https://api.sboit.rf/v1/services', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
})
.then(res => res.json())
.then(data => console.log(data));

Ответ

{
  "data": [
    {
      "id": "sberbank",
      "name": "Сбербанк",
      "status": "operational",
      "current_issues": 12,
      "uptime_24h": 99.9,
      "tags": ["банки", "финансы", "переводы"]
    }
  ],
  "total": 150
}

GET

/services/:id

Получить информацию о конкретном сервисе

const response = await fetch('https://api.sboit.rf/v1/services/tinkoff', {
  headers: { 'Authorization': 'Bearer sk_live_your_api_key' }
});
const service = await response.json();

GET

/services/search

Поиск сервисов по названию или тегам

Параметры

q Поисковый запрос

tags Фильтр по тегам (через запятую)

category ID категории

GET

/services/:id/status

Получить текущий статус сервиса

{
  "service_id": "tinkoff",
  "status": "degraded",
  "last_check": "2024-01-15T11:30:00Z",
  "issues": {
    "current": 156,
    "peak_24h": 423,
    "avg_24h": 89
  },
  "problems": {
    "app": 60,
    "auth": 24,
    "other": 16
  }
}

GET

/services/:id/history

Получить историю статусов за период

Параметры

period 1h, 6h, 24h, 7d, 30d (по умолчанию 24h)

GET

/services/:id/uptime

Получить статистику доступности

{
  "service_id": "tinkoff",
  "uptime": {
    "24h": 99.2,
    "7d": 98.5,
    "30d": 99.1
  },
  "outages": [
    {
      "start": "2024-01-15T10:00:00Z",
      "end": "2024-01-15T10:45:00Z",
      "duration_minutes": 45
    }
  ]
}

Webhooks позволяют получать уведомления о сбоях в реальном времени

Формат payload

{
  "event": "status_change",
  "service": {
    "id": "tinkoff",
    "name": "Тинькофф",
    "status": "outage",
    "previous_status": "operational"
  },
  "timestamp": "2024-01-15T11:00:00Z",
  "issues_count": 423
}

Типы событий

status_change
Изменение статуса сервиса
outage_start
Начало сбоя
outage_end
Окончание сбоя
spike
Резкий рост жалоб
monitoring_down
Ваш сайт недоступен
monitoring_up
Ваш сайт снова работает

POST

/webhooks

Создать новый webhook

fetch('https://api.sboit.rf/v1/webhooks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://your-server.com/webhook',
    events: ['status_change', 'outage_start'],
    services: ['tinkoff', 'sberbank'] // или ['*'] для всех
  })
});

POST

/reports

Отправить жалобу о сбое

fetch('https://api.sboit.rf/v1/reports', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    service_id: 'tinkoff',
    problem_type: 'app',
    description: 'Приложение не открывается',
    region: 'Москва'
  })
});

GET

/reports/:service_id

Получить жалобы по сервису

Параметры

period 1h, 6h, 24h, 7d

type app, website, auth, payments, api, other

Эти endpoints доступны только владельцам сервисов с правами администратора

PUT

/admin/services/:id

Обновить информацию о сервисе

fetch('https://api.sboit.rf/v1/admin/services/my-service', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer sk_live_admin_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Мой Сервис',
    description: 'Новое описание',
    url: 'https://my-service.com',
    tags: ['финтех', 'платежи']
  })
});

PUT

/admin/services/:id/status

Обновить статус сервиса вручную

{
  "status": "degraded",
  "message": "Проводим плановые работы",
  "eta": "30 минут"
}

GET

/admin/services/:id/analytics

Получить аналитику по сервису

{
  "views": {
    "today": 1523,
    "week": 10234,
    "month": 45678
  },
  "subscribers": 2341,
  "reports": {
    "today": 12,
    "week": 89
  }
}

API для управления официальными комментариями техподдержки на странице сервиса

POST

/admin/services/:id/support-message

Опубликовать сообщение от техподдержки

fetch('https://api.sboit.rf/v1/admin/services/my-service/support-message', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_admin_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    message: 'Нам известно о проблеме. Работаем над исправлением.',
    eta: '30 минут',
    severity: 'warning' // info, warning, critical
  })
});

PUT

/admin/services/:id/support-message/:message_id

Обновить сообщение техподдержки

{
  "message": "Проблема устранена. Приносим извинения за неудобства.",
  "eta": null,
  "resolved": true
}

DELETE

/admin/services/:id/support-message/:message_id

Удалить сообщение техподдержки

Лимиты

1000

запросов/час (Free)

10000

запросов/час (Pro)

∞

Enterprise

API Документация

Base URL

Аутентификация

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

Ответ

Параметры

Параметры

Настройка Webhooks

Формат payload

Типы событий

Параметры

Лимиты