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

Публичный API мониторинга игровых серверов. Read-only эндпоинты для списков, карточек, онлайна и истории. Авторизация только для управления своим сервером, RCON и биллинга.

Обзор

Публичный API RiseOfServers отдаёт статус игровых серверов (CS2, DayZ, Rust, ARK, Minecraft, SAMP, GTA 5, ARMA 3 и др.) в реальном времени. API read-only, ключ не требуется для публичных данных. Ограничение — 60 запросов в минуту с одного IP.

Базовый URL

https://api.riseofservers.ru/api — все запросы идут на HTTPS. Возвращается application/json в UTF-8. Ошибки соответствуют стандарту Laravel — HTTP 4xx/5xx + поле message.

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

Публичные эндпоинты (списки серверов, карточки, гайды, новости) открыты без авторизации. Запись и управление сервером (RCON, редактирование карточки, тарифы) — Bearer-токен Laravel Sanctum: заголовок Authorization: Bearer <token>. Токен выпускается после логина через /api/auth/login.

Ключевые эндпоинты

GET /api/servers — список серверов с фильтрами game, status, page, per_page. GET /api/servers/{id} — карточка сервера по ID. GET /api/servers/{id}/players — текущий список игроков. GET /api/servers/{id}/history — история онлайна за период. GET /api/games — справочник поддерживаемых игр. GET /api/guides — список гайдов, GET /api/guides/{slug} — карточка. GET /api/news и GET /api/news/{slug} — новости. GET /api/plans — список тарифов. POST /api/auth/login и POST /api/auth/register — авторизация.

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

Получить топ-20 онлайн-серверов DayZ: curl "https://api.riseofservers.ru/api/servers?game=dayz&status=online&per_page=20". Ответ — JSON-объект {data: [...], meta: {total, per_page, current_page}}. Каждый элемент содержит id, name, slug, ip, port, current_players, max_players, ping, map, uptime_percent, region, description.

Виджеты и интеграции

Встраиваемый виджет мониторинга — iframe https://riseofservers.ru/embed/server/{id} со стандартными параметрами ?theme=dark|light&lang=ru|en. Telegram-уведомления о падении сервера настраиваются в личном кабинете — достаточно привязать Telegram-аккаунт. RCON-консоль работает из личного кабинета через WebSocket, ключи хранятся зашифрованными.

Лимиты и политика использования

Лимит — 60 запросов в минуту с одного IP на публичные эндпоинты и 600 запросов в минуту для авторизованных пользователей. При превышении — HTTP 429 Too Many Requests с заголовком Retry-After. Коммерческое использование данных мониторинга (скрапинг, ресейл) запрещено без согласования через страницу поддержки https://riseofservers.ru/suggestions-support.

Поддержка

Вопросы по API, запросы на повышение лимита и сообщения о багах — через страницу поддержки https://riseofservers.ru/suggestions-support. Укажите User-Agent, публичный IP, время запроса по МСК и тело запроса. Отвечаем в любое время.

Частые вопросы по API

Нужен ли ключ для публичного API?
Нет, чтение публичных данных (списки серверов, карточки, гайды, новости) открыто без авторизации. Ключ нужен только для управления своим сервером, RCON, биллинга — авторизация через Bearer-токен Laravel Sanctum.
Какие лимиты у API?
60 запросов в минуту с одного IP для неавторизованных клиентов и 600 запросов в минуту для авторизованных. При превышении приходит HTTP 429 с заголовком Retry-After. Нужен больший лимит — создайте обращение на странице поддержки https://riseofservers.ru/suggestions-support с описанием сценария.
Можно ли встроить мониторинг сервера на свой сайт?
Да, через iframe https://riseofservers.ru/embed/server/{id}. Поддерживаются параметры ?theme=dark|light и ?lang=ru|en. Виджет показывает онлайн, пинг, карту и IP; обновляется раз в 60 секунд.
В каком формате отдаётся ответ?
application/json в кодировке UTF-8. Списки обёрнуты в {data: [...], meta: {total, per_page, current_page}} — Laravel API resource. Даты — ISO 8601 по Europe/Moscow. Ошибки — HTTP-статус + поле message и опционально errors для валидации.
Можно ли использовать данные мониторинга на своём проекте?
Некоммерческое использование с указанием источника и ссылкой на riseofservers.ru допускается. Коммерческое использование, ресейл, скрапинг на автоматическую агрегацию — только по согласованию через страницу поддержки https://riseofservers.ru/suggestions-support. Использование без атрибуции может привести к блокировке IP.