API · Horizon Dispatch

Openbare API zonder sleutel

Het eenvoudigst: geen sleutel, geen boost, voor alle VTC’s. Vervang ma-vtc door de identificatie van je VTC (het adres van zijn pagina /vtcs/ma-vtc). JSON, alleen lezen, open CORS, 120 verzoeken / minuut / IP.

GET https://hdispatch.eu/api/vtc                       lijst van beschikbare endpoints
GET https://hdispatch.eu/api/vtc/ma-vtc/stats          leden, online, km (totaal en maand), volgend event, certificering
GET https://hdispatch.eu/api/vtc/ma-vtc/online         online chauffeurs (inclusief posities)
GET https://hdispatch.eu/api/vtc/ma-vtc/jobs?limit=10  laatste leveringen (1 tot 50, standaard 10)
GET https://hdispatch.eu/api/vtc/ma-vtc/events?limit=5 komende openbare events (1 tot 20, standaard 5)
GET https://hdispatch.eu/api/vtc/ma-vtc/members        actieve leden gerangschikt op kilometers (1 tot 200, standaard 50), als de VTC ze openbaar maakt
GET https://hdispatch.eu/api/vtc/ma-vtc/certification  controleerbare certificeringsstatus

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'));

Respecteert de instellingen van de VTC: namen verborgen als „leden tonen” uit staat, geen inkomsten als die niet openbaar zijn, API volledig uit te schakelen in Instellingen → API. Antwoorden worden 5 seconden (online) tot 5 minuten (certificering) gecachet. Fouten: 404 {"error":"not_found"} als de VTC niet bestaat, op de blacklist staat of haar API heeft uitgeschakeld; 429 {"success":false,"message":…} boven de limiet. Gebruik voor gedetailleerde gegevens de v1-API met sleutel hieronder.

Widgets voor de site van je VTC

Online leden, laatste ritten, kilometers van de maand, volgend event, werving, volledige kaart of live minikaart. Gratis, in 9 talen, licht of donker thema. De codes om te plakken staan in Dashboard → je VTC → Widgets & 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

Overige

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

Zonder JavaScript werkt elke widget ook als iframe: https://hdispatch.eu/widgets/vtc/ma-vtc/online?theme=dark. De widgets verversen zichzelf (30 s voor „online”, tot 10 min voor „werving”) en tonen een fout als de VTC haar API heeft uitgeschakeld. Certificeringsbadge: https://hdispatch.eu/badges/vtc/ma-vtc.svg (of .png), opties ?style=flat, ?theme=light, ?lang=en, controleerbaar op https://hdispatch.eu/verify/ma-vtc.

Snel aan de slag

Ontgrendel de API — die hoort bij het niveau 5 boosts (net als de VTC-website).
Haal je openbare sleutel op in Dashboard → Instellingen → API. Hij begint met pk_ en mag zonder gevaar zichtbaar zijn.
Roep de API aan met je sleutel in de header x-api-key (of als parameter ?key=).

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

Authenticatie & regels

Basis-URL

https://hdispatch.eu/api/v1

Header

x-api-key: pk_…

Methoden

GET (alleen lezen)

Rate limit

120 verzoeken / minuut / sleutel

Formaat

JSON · CORS *

Toegang

Niveau 5 boosts vereist

GET https://hdispatch.eu/api/v1 geeft de lijst met endpoints terug. Fouten hebben de vorm {"error":"…"} (zie hieronder).

⚠️ Verwar je openbare sleutel (pk_…, lezen) niet met je tracker-sleutel (geheim, schrijven): die laatste mag nooit op een webpagina staan. Een VTC kan haar API uitschakelen of bepaalde velden (inkomsten, leden) verbergen via haar instellingen.

GET /api/v1/vtc

Info en totalen van de VTC (leden, km, aanmaakdatum…).

Voorbeeldantwoord

{
  "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

Leden van de VTC, gesorteerd op kilometerstand (standaard 100).

Voorbeeldantwoord

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

GET /api/v1/events

Komende events van de VTC, zowel openbaar als alleen voor leden (max. 50).

Voorbeeldantwoord

{
  "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

Recente leveringen (standaard 50).

Voorbeeldantwoord

{
  "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

Online chauffeurs (aanwezigheid < 60 s).

Voorbeeldantwoord

{
  "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

Openbare en gepubliceerde aankondigingen van de VTC.

Voorbeeldantwoord

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

GET /api/v1/partners

Geaccepteerde samenwerkingen (partner-VTC’s).

Voorbeeldantwoord

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

GET /api/v1/divisions

Transportdivisies van de VTC.

Voorbeeldantwoord

{
  "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

Openbare fotogalerijen van de VTC (albums gepubliceerd vanuit het dashboard).

Voorbeeldantwoord

{
  "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

Horizon Dispatch-events (globaal, alle openbare VTC’s).

Voorbeeldantwoord

{
  "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": "" }
  ]
}

Fouten

Code

error

Betekenis

401

missing_api_key

Geen sleutel opgegeven.

403

invalid_api_key

Onbekende sleutel.

403

boost_required

De VTC heeft het niveau van 5 boosts niet.

403

api_disabled

De VTC heeft haar openbare API uitgeschakeld.

403

members_hidden

De VTC verbergt de ledenlijst (/members).

429

rate_limited

Rate limit overschreden (zie de header Retry-After).

500

server_error

Interne fout, probeer het later opnieuw.

Horizon Connect (OAuth 2)

Voeg „Inloggen met Horizon Dispatch” toe aan je site. Maak de applicatie aan in Dashboard → je VTC → Ecosysteem: het secret wordt maar één keer getoond.

GET  https://hdispatch.eu/connect/authorize?client_id=…&redirect_uri=…&scope=identity%20profile%20vtc&state=…
     (PKCE: voeg code_challenge toe, berekend met 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>

De autorisatiecode is 5 minuten geldig en kan maar één keer worden gebruikt; het token 30 dagen. Scopes: identity (identificatie), profile (profiel), vtc (VTC van de gebruiker).

Widget om te kopiëren

Plak dit in je site en vervang pk_VOTRE_CLE door je openbare sleutel:

<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>

Horizon Dispatch-API

Openbare API zonder sleutel

Widgets voor de site van je VTC

Snel aan de slag

Authenticatie & regels

Endpoints

Fouten

Horizon Connect (OAuth 2)

Widget om te kopiëren