Overzicht van de TrackRoad API-referentie

TrackRoad biedt REST- en SOAP-API's om u te helpen applicaties te bouwen voor route-optimalisatie, dispatching van meerdere voertuigen, geocodering, routering en ETA- en afstandsberekeningen.

Gebruik deze API-hub om authenticatie, service-basis-URL's en de lijst met beschikbare REST-endpoints en SOAP-bewerkingen voor TrackRoad-routerings- en dispatchintegraties te vinden.

Overzicht van de TrackRoad API-referentie met REST-endpoints, SOAP-bewerkingen en authenticatie met TrackServiceKey
Overzicht van de API-referentie: REST-endpoints, SOAP-bewerkingen en authenticatie met TrackServiceKey.

Voordat u begint

Hebt u het volledige REST-contract nodig?

Swagger biedt de volledige lijst met REST-endpoints, parameters, aanvraagmodellen en responsmodellen voor een snellere integratie van de TrackRoad API.

Swagger UI bekijken Dispatch-API

Inhoudsopgave

  1. REST- en SOAP-basis-URL's
  2. REST API-endpoints
  3. SOAP API-bewerkingen
  4. REST-authenticatie (X-API-Key)
  5. SOAP-authenticatie (SessionIDHeader)
  6. Login / Logout (verouderd)
  7. Best practices voor beveiliging
  8. Veelvoorkomende authenticatiefouten
  9. Veelgestelde vragen

REST- en SOAP-basis-URL's#

TrackRoad biedt twee API-stijlen: REST en SOAP. Alle endpoints zijn gebaseerd op dezelfde servicehost.

API URL
Basis-URL https://trackservice.trackroad.com
REST-basis-URL https://trackservice.trackroad.com/rest
SOAP-service-endpoint https://trackservice.trackroad.com/TrackService.asmx

REST API-endpoints#

REST-aanroepen worden gedefinieerd door HTTP-methode + endpoint. Dit overzicht helpt ontwikkelaars snel TrackRoad-endpoints voor dispatch, geocodering, routering, krediet en verouderde authenticatie te vinden.

HTTP-methode Endpoint Bewerking Beschrijving
POST /rest/dispatch Dispatch Optimaliseer en dispatch stops over meerdere voertuigen, inclusief stopvolgorde, ETA, afstand, duur en overgeslagen of niet-toegewezen stops.
Docs: Dispatch-API
POST /rest/geocode Geocodering Zet adressen om in breedte- en lengtegraadcoördinaten, optioneel met een score voor overeenkomstvertrouwen.
Docs: Geocoderings-API
POST /rest/route Route Bereken een route op basis van een reeks locaties voor routerings-, navigatie- en reistijdtoepassingen.
Docs: Route-API
POST /rest/routes Routes Bereken meerdere routes in één aanvraag voor batchroutering en wagenparkplanningsworkflows.
Docs: Routes-API
POST /rest/credit Krediet Geeft het resterende aantal beschikbare credits voor de TrackRoad-account of integratie terug.
Docs: Credit-API
POST /rest/login Login (verouderd) Verouderd endpoint dat een API-sleutel retourneert voor oudere integraties. Nieuwe implementaties moeten API-sleutelauthenticatie rechtstreeks gebruiken.
Docs: API-authenticatie
POST /rest/logout Logout (verouderd) Verouderd endpoint dat een verouderde sessie beëindigt.

Gebruik Swagger UI voor het volledige REST-contract, inclusief parameters, modellen en actuele details van het aanvraag- en responsschema.

SOAP API-bewerkingen#

SOAP-aanroepen worden gedefinieerd door service-endpoint + bewerking + SOAPAction. Alle bewerkingen worden via HTTP POST aangeroepen op het TrackRoad SOAP-service-endpoint.

Authenticatie: Neem voor SOAP-aanvragen SessionIDHeader op en stel SessionID in op uw API-sleutel (TrackServiceKey). Login en Logout zijn verouderd en niet vereist voor nieuwe integraties.

Service-endpoint Bewerking SOAPAction Beschrijving
/TrackService.asmx Dispatch http://TrackService.TrackRoad.com/Dispatch Dispatch en optimaliseer grote stoplijsten over meerdere voertuigen voor workflows voor route-optimalisatie.
Docs: Dispatch-API
/TrackService.asmx Geocode http://TrackService.TrackRoad.com/Geocode Accepteert een lijst met adressen of locaties en retourneert gegeocodeerde stops met breedtegraad, lengtegraad en optionele matchcodes.
Docs: Geocoderings-API
/TrackService.asmx CalculateRoute http://TrackService.TrackRoad.com/CalculateRoute Genereer stapsgewijze routebeschrijvingen en routekaarten voor één route.
Docs: Route-API
/TrackService.asmx CalculateRoutes http://TrackService.TrackRoad.com/CalculateRoutes Genereer routebeschrijvingen en kaarten voor meerdere routes, inclusief een overzichtskaart voor alle routes.
Docs: Routes-API
/TrackService.asmx CalculateDistance http://TrackService.TrackRoad.com/CalculateDistance Geeft de rijafstand en reistijd van punt A naar punt B terug.
/TrackService.asmx CreditRemaining http://TrackService.TrackRoad.com/CreditRemaining Geeft het resterende aantal credits voor de account terug.
Docs: Credit-API
/TrackService.asmx GetRouteList http://TrackService.TrackRoad.com/GetRouteList Geeft een lijst terug van routes die in een account zijn aangemaakt, met filters zoals datumbereik, eigenaar en routenaam.
/TrackService.asmx GetRoute http://TrackService.TrackRoad.com/GetRoute Geeft een route terug op basis van RouteID.
/TrackService.asmx GetTrack http://TrackService.TrackRoad.com/GetTrack Accepteert FromDate en ToDate in UTC en retourneert GPS-coördinaten met UTC-tijdstempels voor de geselecteerde periode.
/TrackService.asmx Login http://TrackService.TrackRoad.com/Login Verouderde sessiegebaseerde authenticatie. Nieuwe integraties moeten TrackServiceKey verzenden als SessionIDHeader en SessionID.
Docs: API-authenticatie
/TrackService.asmx Logout http://TrackService.TrackRoad.com/Logout Beëindigt een verouderde SOAP-sessie.

WSDL: https://trackservice.trackroad.com/TrackService.asmx?WSDL

REST-authenticatie (X-API-Key)#

Verzend voor REST-aanvragen uw API-sleutel (TrackServiceKey) in de X-API-Key-header bij elke aanvraag.

curl -X POST "https://trackservice.trackroad.com/rest/dispatch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY" \
  -d '{ }'

Bewaar API-sleutels aan de serverzijde. Neem geen sleutels op in browser- of mobiele clientcode.

SOAP-authenticatie (SessionIDHeader)#

Neem voor SOAP-aanvragen SessionIDHeader op en stel SessionID in op uw API-sleutel (TrackServiceKey).

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

Example SOAP call (Dispatch)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <Dispatch xmlns="http://TrackService.TrackRoad.com/">
      <specification>
        <RoutingService>NetRoad</RoutingService>
        <DistanceUnit>Mile</DistanceUnit>
        <RouteOptimize>MinimizeTime</RouteOptimize>
        <Vehicles>
          <Vehicle><Name>Truck 1</Name></Vehicle>
        </Vehicles>
        <Locations>
          <Location>
            <Address>
              <Street>1 Market St</Street>
              <City>San Francisco</City>
              <State>CA</State>
              <PostalCode>94105</PostalCode>
              <Country>USA</Country>
            </Address>
          </Location>
        </Locations>
      </specification>
    </Dispatch>
  </soap:Body>
</soap:Envelope>

Stel de juiste SOAPAction HTTP-header in voor elke SOAP-bewerking bij het aanroepen van de TrackRoad SOAP API.

Login / Logout (verouderd)#

Verouderingsmelding: Login en Logout blijven gedocumenteerd voor oudere integraties, maar zijn niet vereist voor nieuwe implementaties. Nieuwe integraties moeten een API-sleutel (TrackServiceKey) gebruiken die in de TrackRoad-account is gegenereerd.

  • Voorkeur: API-sleutelauthenticatie — API-authenticatie
  • Verouderd: REST /rest/login, /rest/logout en SOAP Login / Logout.

Best practices voor beveiliging#

  • Neem API-sleutels nooit op in client-side code zoals browsers of mobiele apps. Bewaar sleutels aan de serverzijde.
  • Gebruik uitsluitend HTTPS voor alle TrackRoad API-aanvragen.
  • Vervang sleutels als ze zijn blootgesteld en beperk wie toegang heeft tot productiecredentials.
  • Vermijd het loggen van geheimen zoals headers, API-sleutels of volledige payloads met gevoelige gegevens.

Veelvoorkomende authenticatiefouten#

  • 401 / Niet geautoriseerd: Ontbrekende of ongeldige X-API-Key voor REST, of ontbrekende of ongeldige SessionIDHeader voor SOAP.
  • 403 / Verboden: De sleutel is geldig, maar geblokkeerd, verlopen of zonder credits.

Veelgestelde vragen#

Hoe authenticeer ik bij de TrackRoad REST API?
Verzend uw API-sleutel (TrackServiceKey) in de X-API-Key-header bij elke REST-aanvraag.
Hoe authenticeer ik bij de TrackRoad SOAP API?
Neem SessionIDHeader op in SOAP-aanvragen en stel SessionID in op uw API-sleutel (TrackServiceKey). Login en Logout zijn verouderd en niet vereist voor nieuwe integraties.
Heb ik Login en Logout nog steeds nodig?
Nee voor nieuwe integraties. Moderne TrackRoad-integraties moeten API-sleutelauthenticatie gebruiken. Login en Logout blijven bestaan voor achterwaartse compatibiliteit met oudere implementaties.
Waar kan ik het volledige REST API-contract vinden?
Gebruik Swagger UI om de volledige lijst met REST-endpoints, parameters, aanvraagmodellen en responsmodellen te bekijken.

Klaar om te bouwen met TrackRoad?

Genereer uw API-sleutel (TrackServiceKey) en verken vervolgens het volledige REST-contract in Swagger of ga verder met de documentatie van de Dispatch-API.

API-sleutel ophalen Swagger UI bekijken