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:

Повний Приклад