API-authenticatie (TrackServiceKey)

TrackRoad API's gebruiken een API-sleutel genaamd TrackServiceKey. Voor REST verstuurt u die als X-API-Key. Voor SOAP verstuurt u die in SessionIDHeader als SessionID.

TrackRoad API-authenticatiestroom die laat zien dat TrackServiceKey wordt gebruikt als X-API-Key voor REST en SessionIDHeader voor SOAP
Overzicht van authenticatie: TrackServiceKey is uw API-sleutel — verstuur die als X-API-Key voor REST en als SessionIDHeader/SessionID voor SOAP.

Endpoints en modellen nodig?

Swagger biedt de volledige aanvraag- en antwoordschema's voor Dispatch, Routes, Route, Geocode, Credit en Distance.

Swagger UI bekijken Overzicht van API-referentie

Inhoudsopgave

  1. Hoe authenticatie werkt
  2. Genereer uw TrackServiceKey
  3. REST-authenticatie (X-API-Key)
  4. SOAP-authenticatie (SessionIDHeader)
  5. Login / Logout (verouderd)
  6. Best practices voor beveiliging
  7. Veelvoorkomende fouten (401/403)
  8. Gerelateerde endpoints
  9. FAQ

Hoe authenticatie werkt#

TrackRoad gebruikt één enkel authenticatieconcept voor het volledige API-oppervlak: uw accountbrede TrackServiceKey.

  • De TrackServiceKey wordt gegenereerd in uw TrackRoad-account.
  • REST: verstuur die in X-API-Key bij elk verzoek.
  • SOAP: verstuur die in SessionIDHeader als SessionID bij elke aanroep.

Aanbevolen voor nieuwe integraties: gebruik waar mogelijk REST en behoud SOAP alleen voor verouderde systemen.

Genereer uw TrackServiceKey#

Voordat u de TrackRoad API aanroept, maakt of kopieert u uw authenticatiesleutel vanuit uw account.

  1. Meld u aan bij uw TrackRoad-account.
  2. Open Gebruikers beheren (of API-instellingen, indien beschikbaar).
  3. Genereer of kopieer uw TrackServiceKey.
  4. Sla die alleen veilig op aan de serverzijde.

Als u uw TrackServiceKey niet kunt vinden, neem dan contact op met TrackRoad Support om API-toegang in te schakelen of te bevestigen.

REST-authenticatie (X-API-Key)#

Verstuur uw TrackServiceKey in de X-API-Key-header bij elk REST-verzoek aan TrackRoad.

curl -X POST "https://trackservice.trackroad.com/rest/credit" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY"

Bewaar API-sleutels aan de serverzijde. Verwerk TrackServiceKey niet in browser-JavaScript, mobiele apps of openbare client-side code.

SOAP-authenticatie (SessionIDHeader)#

SOAP-aanroepen authenticeren met SessionIDHeader. Voor TrackRoad SOAP-services verstuurt u uw TrackServiceKey als de waarde SessionID bij elk verzoek.

Login en Logout kunnen nog voorkomen in oudere SOAP-documentatie, maar zijn niet vereist voor moderne integraties die al TrackServiceKey gebruiken.

<soap:Header>
  <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
    <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
  </SessionIDHeader>
</soap:Header>

Login / Logout-endpoints (verouderd)#

Login en Logout worden alleen onderhouden voor achterwaartse compatibiliteit. Nieuwe TrackRoad-integraties moeten authenticeren met TrackServiceKey: REST via X-API-Key en SOAP via SessionIDHeader.

Best practices voor beveiliging#

Het beschermen van uw API-sleutel is essentieel voor betrouwbare en veilige productie-integraties.

  • Stel API-sleutels nooit bloot in front-end JavaScript.
  • Gebruik veilige server-naar-server- of backendintegraties.
  • Sla sleutels op in omgevingsvariabelen, secret managers of beveiligde configuratieopslag.
  • Roteer de sleutel onmiddellijk als u een compromittering vermoedt.
  • Log of e-mail API-sleutels nooit in platte tekst.

Veelvoorkomende fouten (401/403)#

Als authenticatie mislukt, controleer dan de headernaam, de sleutelwaarde, de omgeving en de accountstatus.

  • 401 Unauthorized: ontbrekende of ongeldige sleutel. Controleer voor REST X-API-Key. Controleer voor SOAP SessionIDHeader en SessionID.
  • 403 Forbidden: de sleutel kan geldig zijn, maar de toegang is geblokkeerd, verlopen of beperkt door tegoed of machtigingen.

FAQ#

Hoe authenticeer ik TrackRoad REST API-aanroepen?
Verstuur uw TrackServiceKey in de X-API-Key-header bij elk REST-verzoek.
Hoe authenticeer ik TrackRoad SOAP-aanroepen?
Voor SOAP verstuurt u uw TrackServiceKey in SessionIDHeader als SessionID bij elk SOAP-verzoek.
Heb ik Login/Logout nodig?
Nee. Login- en Logout-endpoints zijn verouderd. Nieuwe integraties moeten TrackServiceKey-authenticatie gebruiken.
Waarom krijg ik 401 Unauthorized?
Veelvoorkomende oorzaken zijn een ontbrekende X-API-Key-header, een ongeldige sleutel, extra witruimtes of het gebruik van de verkeerde omgeving of host.

Volgende stap: probeer een endpoint

Zodra u uw TrackServiceKey hebt, begint u met Credit om authenticatie te valideren en gaat u daarna verder met Geocode, Route, Routes of Dispatch.

Credit controleren Naar Dispatch