API · Horizon Dispatch

API pubblica senza chiave

La soluzione più semplice: nessuna chiave, nessun boost, per tutte le VTC. Sostituisci ma-vtc con l’identificativo della tua VTC (l’indirizzo della sua pagina /vtcs/ma-vtc). JSON, sola lettura, CORS aperto, 120 richieste / minuto / IP.

GET https://hdispatch.eu/api/vtc                       elenco degli endpoint disponibili
GET https://hdispatch.eu/api/vtc/ma-vtc/stats          membri, online, km (totale e mese), prossimo evento, certificazione
GET https://hdispatch.eu/api/vtc/ma-vtc/online         autisti online (posizioni incluse)
GET https://hdispatch.eu/api/vtc/ma-vtc/jobs?limit=10  ultime consegne (da 1 a 50, 10 di default)
GET https://hdispatch.eu/api/vtc/ma-vtc/events?limit=5 prossimi eventi pubblici (da 1 a 20, 5 di default)
GET https://hdispatch.eu/api/vtc/ma-vtc/members        membri attivi ordinati per chilometri (da 1 a 200, 50 di default), se la VTC li rende pubblici
GET https://hdispatch.eu/api/vtc/ma-vtc/certification  stato di certificazione verificabile

fetch('https://hdispatch.eu/api/vtc/ma-vtc/stats')
  .then((r) => r.json())
  .then((d) => console.log(d.members.online + ' en ligne · ' + d.month.km + ' km ce mois-ci'));

Rispetta le impostazioni della VTC: nomi nascosti se «mostra i membri» è disattivato, ricavi assenti se non sono pubblici, API completamente disattivabile in Impostazioni → API. Le risposte sono memorizzate in cache da 5 secondi (online) a 5 minuti (certificazione). Errori: 404 {"error":"not_found"} se la VTC non esiste, è in blacklist o ha disattivato la sua API; 429 {"success":false,"message":…} oltre il limite. Per i dati dettagliati, usa l’API v1 con chiave qui sotto.

Widget per il sito della tua VTC

Membri online, ultimi viaggi, chilometri del mese, prossimo evento, reclutamento, scheda completa o mini mappa live. Gratuiti, in 9 lingue, tema chiaro o scuro. I codici pronti da incollare sono in Dashboard → la tua VTC → Widget & badge.

<div class="hd-widget" data-vtc="ma-vtc" data-type="online"></div>
<script src="https://hdispatch.eu/widgets/embed.js" async></script>

data-type

online · jobs · km · event · recruit · card · map

data-theme

dark · light · auto

data-lang

fr en de es it nl pl pt tr

Altri

data-accent="ff8800" · data-limit="1..15" · data-header="0" · data-height="360" · data-game="ats" (mappa)

Senza JavaScript, ogni widget funziona anche in iframe: https://hdispatch.eu/widgets/vtc/ma-vtc/online?theme=dark. I widget si aggiornano da soli (30 s per «online», fino a 10 min per «reclutamento») e mostrano un errore se la VTC ha disattivato la sua API. Badge di certificazione: https://hdispatch.eu/badges/vtc/ma-vtc.svg (o .png), opzioni ?style=flat, ?theme=light, ?lang=en, verificabile su https://hdispatch.eu/verify/ma-vtc.

Avvio rapido

Sblocca l’API — fa parte del livello 5 boost (come il sito web della VTC).
Recupera la tua chiave pubblica in Dashboard → Impostazioni → API. Inizia con pk_ e può essere esposta senza rischi.
Chiama l’API con la tua chiave nell’header x-api-key (o come parametro ?key=).

curl -H "x-api-key: pk_VOTRE_CLE" https://hdispatch.eu/api/v1/vtc

Autenticazione e regole

URL di base

https://hdispatch.eu/api/v1

Header

x-api-key: pk_…

Metodi

GET (sola lettura)

Limite di richieste

120 richieste / minuto / chiave

Formato

JSON · CORS *

Accesso

Richiesto il livello 5 boost

GET https://hdispatch.eu/api/v1 restituisce l’elenco degli endpoint. Gli errori hanno la forma {"error":"…"} (vedi sotto).

⚠️ Non confondere la tua chiave pubblica (pk_…, lettura) con la tua chiave tracker (segreta, scrittura): quest’ultima non deve mai comparire in una pagina web. Una VTC può disattivare la sua API o nascondere alcuni campi (ricavi, membri) dalle sue impostazioni.

GET /api/v1/vtc

Info e totali della VTC (membri, km, data di creazione…).

Esempio di risposta

{
  "id": "6600…", "name": "Horizon Dispatch", "slug": "horizon-dispatch",
  "tag": "[HDX]", "description": "…", "game": "ets2", "color": "#cfd4dc",
  "recruitmentOpen": true, "hdPartner": false, "premium": false,
  "memberCount": 42,
  "totals": { "distanceKm": 1284000, "deliveries": 3120, "revenue": 9800000 },
  "createdAt": "2025-01-08T12:00:00.000Z"
}

GET /api/v1/members?limit=1..500

Membri della VTC, ordinati per chilometraggio (100 di default).

Esempio di risposta

{
  "count": 42,
  "members": [
    { "discordId": "1234…", "name": "Marco", "avatar": "…", "role": "driver",
      "traction": false, "joinedAt": "…",
      "stats": { "distanceKm": 84210, "deliveries": 190, "revenue": 512000 } }
  ]
}

GET /api/v1/events

Prossimi eventi della VTC, sia pubblici sia riservati ai membri (max 50).

Esempio di risposta

{
  "count": 2,
  "events": [
    { "id": "…", "title": "Convoi du dimanche", "game": "ets2", "server": "Simulation 1",
      "departureCity": "Paris", "arrivalCity": "Berlin", "plannedKm": 1050,
      "meetupAt": "…", "startAt": "…", "slots": { "total": 20, "taken": 12 },
      "going": 18, "externalUrl": "" }
  ]
}

GET /api/v1/deliveries?limit=1..200

Consegne recenti (50 di default).

Esempio di risposta

{
  "count": 50,
  "deliveries": [
    { "driverDiscordId": "…", "game": "ets2", "cargo": "Ciment", "from": "Lyon",
      "to": "Milan", "distanceKm": 480, "damagePercent": 0, "truck": "Scania S",
      "at": "…", "income": 42000 }
  ]
}

GET /api/v1/live

Autisti online (presenza < 60 s).

Esempio di risposta

{
  "count": 3,
  "drivers": [
    { "discordId": "…", "name": "Marco", "avatar": "…", "game": "ETS2",
      "onJob": true, "cargo": "Bois", "from": "Oslo", "to": "Stockholm",
      "truck": "Volvo FH", "speed": 88, "distanceLeft": 120, "progressPct": 64 }
  ]
}

GET /api/v1/news?limit=1..100

Annunci pubblici e pubblicati della VTC.

Esempio di risposta

{
  "count": 5,
  "news": [
    { "id": "…", "title": "Recrutement ouvert !", "content": "…", "coverUrl": "…",
      "pinned": true, "authorName": "Léa", "at": "…", "updatedAt": "…" }
  ]
}

GET /api/v1/partners

Partnership accettate (VTC partner).

Esempio di risposta

{
  "count": 3,
  "partners": [
    { "id": "…", "name": "Nordic Logistics", "slug": "nordic-logistics",
      "tag": "[NL]", "logoUrl": "…", "game": "ets2", "since": "…" }
  ]
}

GET /api/v1/divisions

Divisioni di trasporto della VTC.

Esempio di risposta

{
  "count": 4,
  "divisions": [
    { "id": "…", "name": "Frigo", "description": "…", "imageUrl": "…",
      "color": "#4ea1ff", "trucks": ["Scania S"], "trailers": ["Krone Cool"],
      "position": 0 }
  ]
}

GET /api/v1/gallery?limit=1..100

Gallerie fotografiche pubbliche della VTC (album pubblicati dalla dashboard).

Esempio di risposta

{
  "count": 6,
  "galleries": [
    { "id": "…", "title": "Convoi de Noël", "description": "…",
      "images": ["https://…/1.jpg", "https://…/2.jpg"], "photoCount": 2,
      "authorName": "Léa", "discordUrl": "https://discord.com/channels/…",
      "at": "…" }
  ]
}

GET /api/v1/hd/events?limit=1..100

Eventi Horizon Dispatch (globali, tutte le VTC pubbliche).

Esempio di risposta

{
  "count": 10,
  "events": [
    { "id": "…", "title": "Grand convoi HD", "game": "ets2", "server": "Simulation 1",
      "departureCity": "Madrid", "arrivalCity": "Lisbonne", "plannedKm": 620,
      "meetupAt": "…", "startAt": "…",
      "vtc": { "name": "Horizon Dispatch", "slug": "horizon-dispatch", "tag": "[HDX]", "logoUrl": "…" },
      "externalUrl": "" }
  ]
}

Errori

Codice

error

Significato

401

missing_api_key

Nessuna chiave fornita.

403

invalid_api_key

Chiave sconosciuta.

403

boost_required

La VTC non ha il livello 5 boost.

403

api_disabled

La VTC ha disattivato la sua API pubblica.

403

members_hidden

La VTC nasconde l’elenco dei membri (/members).

429

rate_limited

Limite di richieste superato (vedi l’header Retry-After).

500

server_error

Errore interno, riprova più tardi.

Horizon Connect (OAuth 2)

Aggiungi «Accedi con Horizon Dispatch» al tuo sito. Crea l’applicazione in Dashboard → la tua VTC → Ecosistema: il secret viene mostrato una sola volta.

GET  https://hdispatch.eu/connect/authorize?client_id=…&redirect_uri=…&scope=identity%20profile%20vtc&state=…
     (PKCE: aggiungi code_challenge, calcolato in S256)
POST https://hdispatch.eu/connect/token      client_id, client_secret, code, redirect_uri (code_verifier si PKCE)
     → { "access_token": "…", "token_type": "Bearer", "expires_in": 2592000, "scope": "…" }
GET  https://hdispatch.eu/connect/userinfo   Authorization: Bearer <access_token>

Il codice di autorizzazione è valido 5 minuti e si usa una sola volta; il token, 30 giorni. Scope: identity (identificativo), profile (profilo), vtc (VTC dell’utente).

Widget da copiare e incollare

Incolla questo nel tuo sito e sostituisci pk_VOTRE_CLE con la tua chiave pubblica:

<div id="hd-stats">Chargement…</div>
<script>
  fetch("https://hdispatch.eu/api/v1/vtc", { headers: { "x-api-key": "pk_VOTRE_CLE" } })
    .then(function (r) { return r.json(); })
    .then(function (v) {
      document.getElementById("hd-stats").innerHTML =
        "<b>" + v.name + "</b> — " + v.memberCount + " membres · " +
        v.totals.distanceKm.toLocaleString() + " km";
    });
</script>

API Horizon Dispatch

API pubblica senza chiave

Widget per il sito della tua VTC

Avvio rapido

Autenticazione e regole

Endpoint

Errori

Horizon Connect (OAuth 2)

Widget da copiare e incollare