TrackRoad API-Referenzübersicht

TrackRoad bietet REST- und SOAP-APIs, mit denen Sie Anwendungen für Routenoptimierung, Multi-Fahrzeug-Dispatching, Geocoding, Routing sowie ETA- und Distanzberechnungen erstellen können.

Nutzen Sie dieses API-Hub, um Authentifizierung, Service-Basis-URLs und die Liste verfügbarer REST-Endpunkte und SOAP-Operationen für TrackRoad Routing- und Dispatch-Integrationen zu finden.

TrackRoad API-Referenzübersicht mit REST-Endpunkten, SOAP-Operationen und Authentifizierung mit TrackServiceKey
API-Referenzübersicht: REST-Endpunkte, SOAP-Operationen und Authentifizierung mit TrackServiceKey.

Bevor Sie beginnen

Benötigen Sie den vollständigen REST-Vertrag?

Swagger bietet die vollständige Liste der REST-Endpunkte, Parameter, Anfragemodelle und Antwortmodelle für eine schnellere TrackRoad API-Integration.

Swagger UI ansehen Dispatch API

Inhaltsverzeichnis

  1. REST- und SOAP-Basis-URLs
  2. REST-API-Endpunkte
  3. SOAP-API-Operationen
  4. REST-Authentifizierung (X-API-Key)
  5. SOAP-Authentifizierung (SessionIDHeader)
  6. Login / Logout (Legacy)
  7. Sicherheits-Best-Practices
  8. Häufige Authentifizierungsfehler
  9. FAQ

REST- und SOAP-Basis-URLs#

TrackRoad bietet zwei API-Stile: REST und SOAP. Alle Endpunkte verwenden denselben Service-Host.

API URL
Basis-URL https://trackservice.trackroad.com
REST-Basis-URL https://trackservice.trackroad.com/rest
SOAP-Service-Endpunkt https://trackservice.trackroad.com/TrackService.asmx

REST-API-Endpunkte#

REST-Aufrufe werden durch HTTP-Methode + Endpunkt definiert. Diese Übersicht hilft Entwicklern, TrackRoad-Endpunkte für Dispatching, Geocoding, Routing, Guthaben und Legacy-Authentifizierung schnell zu finden.

HTTP-Methode Endpunkt Operation Beschreibung
POST /rest/dispatch Dispatch Optimieren und disponieren Sie Stopps über mehrere Fahrzeuge hinweg, einschließlich Stoppreihenfolge, ETA, Distanz, Dauer sowie übersprungener oder nicht zugewiesener Stopps.
Dokumentation: Dispatch API
POST /rest/geocode Geocode Wandeln Sie Adressen in Breiten- und Längengradkoordinaten um, optional mit Match-Confidence-Bewertung.
Dokumentation: Geocoding API
POST /rest/route Route Berechnen Sie eine Route aus einer Folge von Standorten für Routing-, Navigations- und Fahrzeit-Anwendungsfälle.
Dokumentation: Route API
POST /rest/routes Routes Berechnen Sie mehrere Routen in einer Anfrage für Batch-Routing- und Flottenplanungs-Workflows.
Dokumentation: Routes API
POST /rest/credit Credit Gibt die verbleibende Anzahl verfügbarer Credits für das TrackRoad-Konto oder die Integration zurück.
Dokumentation: Credit API
POST /rest/login Login (Legacy) Legacy-Endpunkt, der für ältere Integrationen einen API-Schlüssel zurückgibt. Neue Implementierungen sollten die API-Schlüssel-Authentifizierung direkt verwenden.
Dokumentation: API-Authentifizierung
POST /rest/logout Logout (Legacy) Legacy-Endpunkt zum Beenden einer Legacy-Sitzung.

Verwenden Sie Swagger UI für den vollständigen REST-Vertrag einschließlich Parametern, Modellen und aktuellen Details zu Anfrage- und Antwortschemas.

SOAP-API-Operationen#

SOAP-Aufrufe werden durch Service-Endpunkt + Operation + SOAPAction definiert. Alle Operationen werden per HTTP POST am TrackRoad SOAP-Service-Endpunkt aufgerufen.

Authentifizierung: Fügen Sie bei SOAP-Anfragen den SessionIDHeader hinzu und setzen Sie SessionID auf Ihren API-Schlüssel (TrackServiceKey). Login und Logout sind Legacy und für neue Integrationen nicht erforderlich.

Service-Endpunkt Operation SOAPAction Beschreibung
/TrackService.asmx Dispatch http://TrackService.TrackRoad.com/Dispatch Disponieren und optimieren Sie große Stopplisten über mehrere Fahrzeuge hinweg für Workflows der Routenoptimierung.
Dokumentation: Dispatch API
/TrackService.asmx Geocode http://TrackService.TrackRoad.com/Geocode Akzeptiert eine Liste von Adressen oder Standorten und gibt geokodierte Stopps mit Breiten- und Längengrad sowie optionalen Match-Codes zurück.
Dokumentation: Geocoding API
/TrackService.asmx CalculateRoute http://TrackService.TrackRoad.com/CalculateRoute Erstellt Abbiegehinweise und Routenkarten für eine einzelne Route.
Dokumentation: Route API
/TrackService.asmx CalculateRoutes http://TrackService.TrackRoad.com/CalculateRoutes Erstellt Wegbeschreibungen und Karten für mehrere Routen einschließlich einer Gesamtkarte für alle Routen.
Dokumentation: Routes API
/TrackService.asmx CalculateDistance http://TrackService.TrackRoad.com/CalculateDistance Gibt Fahrdistanz und Fahrzeit von Punkt A nach Punkt B zurück.
/TrackService.asmx CreditRemaining http://TrackService.TrackRoad.com/CreditRemaining Gibt die verbleibende Anzahl von Credits für das Konto zurück.
Dokumentation: Credit API
/TrackService.asmx GetRouteList http://TrackService.TrackRoad.com/GetRouteList Gibt eine Liste der in einem Konto erstellten Routen zurück, mit Filtern wie Datumsbereich, Eigentümer und Routenname.
/TrackService.asmx GetRoute http://TrackService.TrackRoad.com/GetRoute Gibt eine Route anhand der RouteID zurück.
/TrackService.asmx GetTrack http://TrackService.TrackRoad.com/GetTrack Akzeptiert FromDate und ToDate in UTC und gibt GPS-Koordinaten mit UTC-Zeitstempeln für den ausgewählten Zeitraum zurück.
/TrackService.asmx Login http://TrackService.TrackRoad.com/Login Legacy sitzungsbasierte Authentifizierung. Neue Integrationen sollten TrackServiceKey als SessionIDHeader und SessionID senden.
Dokumentation: API-Authentifizierung
/TrackService.asmx Logout http://TrackService.TrackRoad.com/Logout Beendet eine Legacy-SOAP-Sitzung.

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

REST-Authentifizierung (X-API-Key)#

Senden Sie bei REST-Anfragen Ihren API-Schlüssel (TrackServiceKey) in jedem Request im Header X-API-Key.

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

Speichern Sie API-Schlüssel serverseitig. Betten Sie Schlüssel nicht in Browser- oder Mobile-Client-Code ein.

SOAP-Authentifizierung (SessionIDHeader)#

Fügen Sie bei SOAP-Anfragen den SessionIDHeader hinzu und setzen Sie SessionID auf Ihren API-Schlüssel (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>

Setzen Sie für jede SOAP-Operation den korrekten SOAPAction-HTTP-Header beim Aufruf der TrackRoad SOAP API.

Login / Logout (Legacy)#

Hinweis für Legacy: Login und Logout bleiben für ältere Integrationen dokumentiert, sind für neue Implementierungen jedoch nicht erforderlich. Neue Integrationen sollten einen im TrackRoad-Konto generierten API-Schlüssel (TrackServiceKey) verwenden.

  • Bevorzugt: API-Schlüssel-Authentifizierung — API-Authentifizierung
  • Legacy: REST /rest/login, /rest/logout sowie SOAP Login / Logout.

Sicherheits-Best-Practices#

  • Betten Sie API-Schlüssel niemals in clientseitigen Code wie Browser- oder Mobile-Apps ein. Bewahren Sie Schlüssel serverseitig auf.
  • Verwenden Sie für alle TrackRoad API-Anfragen ausschließlich HTTPS.
  • Rotieren Sie Schlüssel bei Offenlegung und beschränken Sie den Zugriff auf Produktionszugangsdaten.
  • Vermeiden Sie das Protokollieren von Geheimnissen wie Headern, API-Schlüsseln oder vollständigen Payloads mit sensiblen Daten.

Häufige Authentifizierungsfehler#

  • 401 / Unauthorized: Fehlender oder ungültiger X-API-Key bei REST oder fehlender bzw. ungültiger SessionIDHeader bei SOAP.
  • 403 / Forbidden: Der Schlüssel ist gültig, aber blockiert, abgelaufen oder ohne Guthaben.

FAQ#

Wie authentifiziere ich mich mit der TrackRoad REST API?
Senden Sie Ihren API-Schlüssel (TrackServiceKey) bei jeder REST-Anfrage im Header X-API-Key.
Wie authentifiziere ich mich mit der TrackRoad SOAP API?
Fügen Sie SessionIDHeader in SOAP-Anfragen ein und setzen Sie SessionID auf Ihren API-Schlüssel (TrackServiceKey). Login und Logout sind Legacy und für neue Integrationen nicht erforderlich.
Benötige ich weiterhin Login und Logout?
Nein, nicht für neue Integrationen. Moderne TrackRoad-Integrationen sollten die API-Schlüssel-Authentifizierung verwenden. Login und Logout bleiben zur Abwärtskompatibilität mit älteren Implementierungen erhalten.
Wo finde ich den vollständigen REST-API-Vertrag?
Verwenden Sie Swagger UI , um die vollständige Liste der REST-Endpunkte, Parameter, Anfrage- und Antwortmodelle zu durchsuchen.

Bereit, mit TrackRoad zu entwickeln?

Erstellen Sie Ihren API-Schlüssel (TrackServiceKey) und erkunden Sie anschließend den vollständigen REST-Vertrag in Swagger oder fahren Sie mit der Dispatch API-Dokumentation fort.

API-Schlüssel abrufen Swagger UI ansehen