API · Horizon Dispatch

Publiczne API bez klucza

Najprościej: bez klucza, bez boostów, dla wszystkich VTC. Zastąp ma-vtc identyfikatorem swojego VTC (adres jego strony /vtcs/ma-vtc). JSON, tylko odczyt, otwarty CORS, 120 zapytań / minutę / IP.

GET https://hdispatch.eu/api/vtc                       lista dostępnych endpointów
GET https://hdispatch.eu/api/vtc/ma-vtc/stats          członkowie, online, km (łącznie i w miesiącu), następne wydarzenie, certyfikat
GET https://hdispatch.eu/api/vtc/ma-vtc/online         kierowcy online (wraz z pozycjami)
GET https://hdispatch.eu/api/vtc/ma-vtc/jobs?limit=10  ostatnie dostawy (1 do 50, domyślnie 10)
GET https://hdispatch.eu/api/vtc/ma-vtc/events?limit=5 nadchodzące publiczne wydarzenia (1 do 20, domyślnie 5)
GET https://hdispatch.eu/api/vtc/ma-vtc/members        aktywni członkowie według kilometrów (1 do 200, domyślnie 50), jeśli VTC ich upublicznia
GET https://hdispatch.eu/api/vtc/ma-vtc/certification  weryfikowalny status certyfikacji

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

Respektuje ustawienia VTC: nazwy ukryte, gdy „pokazuj członków” jest wyłączone, brak przychodów, jeśli nie są publiczne, API można całkowicie wyłączyć w Ustawienia → API. Odpowiedzi są buforowane od 5 sekund (online) do 5 minut (certyfikat). Błędy: 404 {"error":"not_found"}, jeśli VTC nie istnieje, jest na czarnej liście lub wyłączyło API; 429 {"success":false,"message":…} po przekroczeniu limitu. Do szczegółowych danych użyj poniższego API v1 z kluczem.

Widżety na stronę twojego VTC

Członkowie online, ostatnie trasy, kilometry w miesiącu, następne wydarzenie, rekrutacja, pełna karta lub mini mapa na żywo. Za darmo, w 9 językach, jasny lub ciemny motyw. Kody gotowe do wklejenia znajdziesz w Panel → twoje VTC → Widżety & odznaka.

<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

Inne

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

Bez JavaScriptu każdy widżet działa też jako iframe: https://hdispatch.eu/widgets/vtc/ma-vtc/online?theme=dark. Widżety odświeżają się same (30 s dla „online”, do 10 min dla „rekrutacji”) i wyświetlają błąd, jeśli VTC wyłączyło swoje API. Odznaka certyfikacji: https://hdispatch.eu/badges/vtc/ma-vtc.svg (lub .png), opcje ?style=flat, ?theme=light, ?lang=en, do sprawdzenia na https://hdispatch.eu/verify/ma-vtc.

Szybki start

Odblokuj API — należy do progu 5 boostów (tak jak strona VTC).
Pobierz swój klucz publiczny w Panel → Ustawienia → API. Zaczyna się od pk_ i można go bezpiecznie ujawnić.
Wywołaj API z kluczem w nagłówku x-api-key (lub w parametrze ?key=).

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

Uwierzytelnianie i zasady

Bazowy URL

https://hdispatch.eu/api/v1

Nagłówek

x-api-key: pk_…

Metody

GET (tylko odczyt)

Limit zapytań

120 zapytań / minutę / klucz

Format

JSON · CORS *

Dostęp

Wymagany próg 5 boostów

GET https://hdispatch.eu/api/v1 zwraca listę endpointów. Błędy mają postać {"error":"…"} (patrz niżej).

⚠️ Nie myl klucza publicznego (pk_…, odczyt) z kluczem trackera (tajny, zapis): ten drugi nigdy nie może pojawić się na stronie internetowej. VTC może wyłączyć swoje API lub ukryć niektóre pola (przychody, członkowie) w ustawieniach.

GET /api/v1/vtc

Informacje i sumy VTC (członkowie, km, data utworzenia…).

Przykładowa odpowiedź

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

Członkowie VTC posortowani według przebiegu (domyślnie 100).

Przykładowa odpowiedź

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

GET /api/v1/events

Nadchodzące wydarzenia VTC, publiczne i tylko dla członków (maks. 50).

Przykładowa odpowiedź

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

Ostatnie dostawy (domyślnie 50).

Przykładowa odpowiedź

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

Kierowcy online (obecność < 60 s).

Przykładowa odpowiedź

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

Publiczne i opublikowane ogłoszenia VTC.

Przykładowa odpowiedź

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

GET /api/v1/partners

Zaakceptowane partnerstwa (partnerskie VTC).

Przykładowa odpowiedź

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

GET /api/v1/divisions

Dywizje transportowe VTC.

Przykładowa odpowiedź

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

Publiczne galerie zdjęć VTC (albumy opublikowane z panelu).

Przykładowa odpowiedź

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

Wydarzenia Horizon Dispatch (globalne, wszystkie publiczne VTC).

Przykładowa odpowiedź

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

Błędy

Kod

error

Znaczenie

401

missing_api_key

Nie podano klucza.

403

invalid_api_key

Nieznany klucz.

403

boost_required

VTC nie ma progu 5 boostów.

403

api_disabled

VTC wyłączyło swoje publiczne API.

403

members_hidden

VTC ukrywa listę członków (/members).

429

rate_limited

Przekroczono limit zapytań (zobacz nagłówek Retry-After).

500

server_error

Błąd wewnętrzny, spróbuj ponownie później.

Horizon Connect (OAuth 2)

Dodaj „Zaloguj się przez Horizon Dispatch” do swojej strony. Utwórz aplikację w Panel → twoje VTC → Ekosystem: sekret jest wyświetlany tylko raz.

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

Kod autoryzacyjny jest ważny 5 minut i działa tylko raz; token — 30 dni. Zakresy: identity (identyfikator), profile (profil), vtc (VTC użytkownika).

Widżet do skopiowania

Wklej to na swoją stronę i zastąp pk_VOTRE_CLE swoim kluczem publicznym:

<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

Publiczne API bez klucza

Widżety na stronę twojego VTC

Szybki start

Uwierzytelnianie i zasady

Endpointy

Błędy

Horizon Connect (OAuth 2)

Widżet do skopiowania