Skip to main content
WebSocket Gateway позволяет получать данные сервера ER:LC в реальном времени без необходимости постоянно опрашивать REST API. Подключившись к шлюзу, вы можете подписаться на интересующие вас каналы данных и получать обновления автоматически.

Подключение

URL: wss://api.erlcrussia.com/v2/gateway При подключении к HTTP эндпоинту (не WebSocket) возвращается ошибка 426 с кодом 5020.

Быстрый Старт

Жизненный Цикл Подключения

  1. Подключение — установите WebSocket соединение
  2. Аутентификация — отправьте auth с вашим токеном
  3. Подписка — подпишитесь на нужные каналы через subscribe
  4. Получение данных — получайте обновления в реальном времени
  5. Отписка — отпишитесь от каналов через unsubscribe
  6. Отключение — закройте соединение

Сообщения Клиента

Все сообщения отправляются в формате JSON с полем action.

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

Первое сообщение, которое необходимо отправить после подключения. Без аутентификации все остальные действия будут отклонены.

Ответ При Успехе

После успешной аутентификации автоматически отправляется снимок кеша (если доступен).

Подписка На Каналы

Подпишитесь на один или несколько каналов данных.
Также поддерживается одиночный канал через поле channel:

Ответ

Отказ в Подписке

Если у вас нет прав на определённый канал:

Отписка От Каналов

Отпишитесь от каналов, которые больше не нужны.

Ответ


Получение Кеша

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

Ping

Проверка соединения.

Ответ


Каналы Данных


Структура Данных Каналов

Server

Players

Staff

Queue

JoinLogs

KillLogs

CommandLogs

ModCalls

EmergencyCalls

Vehicles


Сообщения Сервера

Событие Подключения

Отправляется сразу после установления соединения:

Обновление Кеша

При изменении данных сервера всем подписанным клиентам отправляется обновлённый снимок:
Данные возвращаются только для каналов, на которые подписан клиент.

Пустой Кеш

Если кеш недоступен:

Пустой Снимок

Если кеш есть, но нет данных для ваших подписок:

Ошибка


Keep-Alive

Сервер отправляет WebSocket ping каждые 30 секунд. Клиент должен отвечать pong. Если клиент не отвечает, соединение будет закрыто. Для ручной проверки соединения используйте действие ping:

Полный Пример