Skip to main content
El WebSocket Gateway te permite recibir datos del servidor de ER:LC en tiempo real sin necesidad de consultar continuamente la API REST. Al conectarte al gateway, puedes suscribirte a los canales de datos que te interesen y recibir actualizaciones automáticamente.

Conexión

URL: wss://api.erlcrussia.com/v2/gateway Al conectarse al endpoint HTTP (no WebSocket), se devuelve un error 426 con código 5020.

Inicio Rápido

Ciclo de Vida de la Conexión

  1. Conectar — establecer una conexión WebSocket
  2. Autenticar — enviar auth con tu token
  3. Suscribirse — suscribirse a los canales deseados mediante subscribe
  4. Recibir Datos — obtener actualizaciones en tiempo real
  5. Cancelar Suscripción — desuscribirse de canales mediante unsubscribe
  6. Desconectar — cerrar la conexión

Mensajes del Cliente

Todos los mensajes se envían en formato JSON con un campo action.

Autenticación

El primer mensaje que debe enviarse tras conectarse. Sin autenticación, todas las demás acciones serán rechazadas.

Respuesta Exitosa

Tras una autenticación exitosa, se envía automáticamente una instantánea (snapshot) de la caché (si está disponible).

Suscripción a Canales

Suscríbete a uno o más canales de datos.
También se admite un solo canal a través del campo channel:

Respuesta

Suscripción Denegada

Si no tienes acceso a un canal específico:

Cancelación de Suscripción a Canales

Cancela la suscripción a los canales que ya no necesites.

Respuesta


Obtención de Caché

Solicita la instantánea actual de la caché para tus suscripciones.
Devuelve datos únicamente para los canales a los que estás suscrito.

Ping

Comprobación de la conexión.

Respuesta


Canales de Datos


Estructura de Datos de los Canales

Server

Players

Staff

Queue

JoinLogs

KillLogs

CommandLogs

ModCalls

EmergencyCalls

Vehicles


Mensajes del Servidor

Evento de Conexión

Enviado inmediatamente después de establecer la conexión:

Actualización de Caché

Cuando los datos del servidor cambian, se envía una instantánea actualizada a todos los clientes suscritos:
Los datos se devuelven únicamente para los canales a los que el cliente está suscrito.

Caché Vacía

Si la caché no está disponible:

Instantánea Vacía

Si la caché existe pero no hay datos para tus suscripciones:

Error


Keep-Alive

El servidor envía un ping de WebSocket cada 30 segundos. El cliente debe responder con pong. Si el cliente no responde, se cerrará la conexión. Para la comprobación manual de la conexión, utiliza la acción ping:

Ejemplo Completo