Skip to main content
Il Gateway WebSocket ti consente di ricevere i dati del server ER:LC in tempo reale senza la necessità di effettuare continuamente richieste di polling all’API REST. Connettendoti al gateway, puoi iscriverti ai canali di dati di tuo interesse e ricevere gli aggiornamenti automaticamente.

Connessione

URL: wss://api.erlcrussia.com/v2/gateway Se ti connetti all’endpoint tramite protocollo HTTP standard (anziché WebSocket), verrà restituito un errore 426 con codice 5020.

Avvio Rapido

Ciclo di Vita della Connessione

  1. Connessione — stabilire una connessione WebSocket
  2. Autenticazione — inviare il messaggio auth con il tuo token
  3. Iscrizione — iscriversi ai canali desiderati tramite subscribe
  4. Ricezione Dati — ricevere aggiornamenti in tempo reale
  5. Annullamento Iscrizione — disiscriversi dai canali tramite unsubscribe
  6. Disconnessione — chiudere la connessione

Messaggi del Client

Tutti i messaggi vengono inviati in formato JSON con un campo action.

Autenticazione

Il primo messaggio che deve essere inviato dopo la connessione. Senza autenticazione, tutte le altre azioni verranno rifiutate.

Risposta in Caso di Successo

Dopo un’autenticazione riuscita, viene inviato automaticamente uno snapshot della cache (se disponibile).

Iscrizione ai Canali

Iscriviti a uno o più canali di dati.
È supportato anche il singolo canale tramite il campo channel:

Risposta

Iscrizione Negata

Se non disponi dell’accesso a un canale specifico:

Annullamento Iscrizione ai Canali

Disiscriviti dai canali di cui non hai più bisogno.

Risposta


Recupero della Cache

Richiedi lo snapshot corrente della cache per le tue iscrizioni.
Restituisce i dati solo per i canali a cui sei iscritto.

Ping

Verifica dello stato della connessione.

Risposta


Canali Dati


Struttura dei Dati dei Canali

Server

Players

Staff

Queue

JoinLogs

KillLogs

CommandLogs

ModCalls

EmergencyCalls

Vehicles


Messaggi del Server

Evento di Connessione

Inviato immediatamente dopo aver stabilito la connessione:

Aggiornamento Cache

Quando i dati del server cambiano, viene inviato uno snapshot aggiornato a tutti i client iscritti:
I dati vengono restituiti solo per i canali a cui il client è iscritto.

Cache Vuota

Se la cache non è disponibile:

Snapshot Vuoto

Se la cache esiste ma non ci sono dati per le tue iscrizioni:

Errore


Keep-Alive (Controllo Attività)

Il server invia un ping WebSocket ogni 30 secondi. Il client deve rispondere con un pong. Se il client non risponde, la connessione verrà chiusa. Per il controllo manuale della connessione, utilizza l’azione ping:

Esempio Completo