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

REST API Reference

Мониторинг, который никогда не спит. Интегрируйте UptoChristmas в ваши системы автоматизации за считанные минуты.

Базовый URL и Формат

Все запросы отправляются на https://api.uptochristmas.com/v1/. Мы используем стандартные HTTP-методы и возвращаем данные в формате JSON.

Текущая версия API: v1. Дата последнего обновления спецификации: 14 октября 2023.

Методы аутентификации

API Key

Используйте ваш персональный ключ для доступа к данным. Передавайте ключ в заголовке Authorization.

Пример заголовка

Authorization: Bearer uk_live_8f7d6s5a4b3c2d1e0f

Ограничения

Мы применяем лимиты для защиты инфраструктуры. Стандартный план: 1000 запросов/минуту. Премиум: 10,000 запросов/минуту.

При превышении лимита вы получите статус 429 Too Many Requests.

Список эндпоинтов

Основные ресурсы для управления мониторингом и оповещениями.

GET /checks

Возвращает список всех активных проверок доступности для вашей учетной записи.

Параметры

status (optional): фильтр по статусу (up, down, maintenance)
limit (optional): количество записей (по умолчанию 20)

POST /alerts

Создает новое правило оповещения для указанного URL или IP-адреса.

Тело запроса (JSON)

{
  "url": "https://shop.uptochristmas.ru",
  "interval": 60,
  "notify_channels": ["email", "slack"]
}

Примеры запросов и ответов

Пример 1: Получение статуса проверки

Запрос

GET /v1/checks?status=active HTTP/1.1
Host: api.uptochristmas.com
Authorization: Bearer uk_live_8f7d6s5a4b3c2d1e0f

Ответ (200 OK)

{
  "data": [
    {
      "id": "chk_987654321",
      "url": "https://pay.uptochristmas.ru",
      "status": "up",
      "last_checked_at": "2023-10-14T10:30:00Z",
      "response_time_ms": 142
    }
  ],
  "meta": {
    "total": 1
  }
}

Пример 2: Создание алерта

Запрос

POST /v1/alerts HTTP/1.1
Content-Type: application/json

{
  "url": "https://api.partner-site.com",
  "method": "GET",
  "expected_status": 200
}

Ответ (201 Created)

{
  "id": "alt_123456789",
  "message": "Alert created successfully",
  "webhook_url": "https://hooks.uptochristmas.com/v1/alt_123456789"
}

Коды статусов

200 OK

Запрос выполнен успешно. Данные возвращены в теле ответа.

401 Unauthorized

Неверный или отсутствующий API-ключ. Проверьте заголовок Authorization.

404 Not Found

Запрашиваемый ресурс (например, ID проверки) не существует.

500 Internal Server Error

Ошибка на стороне UptoChristmas. Попробуйте повторить запрос через 30 секунд.