Panoramica di riferimento API TrackRoad

TrackRoad offre API REST e SOAP per aiutarti a creare applicazioni per ottimizzazione dei percorsi, dispatch multi-veicolo, geocoding, routing e calcolo di ETA e distanze.

Usa questo hub API per trovare autenticazione, URL di base del servizio e l’elenco degli endpoint REST e delle operazioni SOAP disponibili per integrazioni di routing e dispatch TrackRoad.

Panoramica di riferimento API TrackRoad con endpoint REST, operazioni SOAP e autenticazione con TrackServiceKey
Panoramica di riferimento API: endpoint REST, operazioni SOAP e autenticazione con TrackServiceKey.

Prima di iniziare

Ti serve il contratto REST completo?

Swagger fornisce l’elenco completo degli endpoint REST, dei parametri, dei modelli di richiesta e dei modelli di risposta per accelerare l’integrazione con l’API TrackRoad.

Apri Swagger UI Dispatch API

Indice dei contenuti

  1. URL di base REST e SOAP
  2. Endpoint API REST
  3. Operazioni API SOAP
  4. Autenticazione REST (X-API-Key)
  5. Autenticazione SOAP (SessionIDHeader)
  6. Login / Logout (legacy)
  7. Best practice di sicurezza
  8. Errori comuni di autenticazione
  9. FAQ

URL di base REST e SOAP#

TrackRoad offre due stili di API: REST e SOAP. Tutti gli endpoint fanno riferimento allo stesso host di servizio.

API URL
URL di base https://trackservice.trackroad.com
URL base REST https://trackservice.trackroad.com/rest
Endpoint del servizio SOAP https://trackservice.trackroad.com/TrackService.asmx

Endpoint API REST#

Le chiamate REST sono definite da metodo HTTP + endpoint. Questa panoramica aiuta gli sviluppatori a trovare rapidamente gli endpoint TrackRoad per dispatch, geocoding, routing, credito e autenticazione legacy.

Metodo HTTP Endpoint Operazione Descrizione
POST /rest/dispatch Dispatch Ottimizza e assegna fermate su più veicoli, includendo ordine delle fermate, ETA, distanza, durata e fermate saltate o non assegnate.
Documentazione: Dispatch API
POST /rest/geocode Geocode Converte indirizzi in coordinate di latitudine e longitudine, opzionalmente con punteggio di affidabilità del match.
Documentazione: Geocoding API
POST /rest/route Route Calcola un percorso da una sequenza di località per casi d’uso di routing, navigazione e tempo di viaggio.
Documentazione: Route API
POST /rest/routes Routes Calcola più percorsi in un’unica richiesta per workflow di routing batch e pianificazione flotte.
Documentazione: Routes API
POST /rest/credit Credit Restituisce il numero di crediti rimanenti disponibili per l’account o l’integrazione TrackRoad.
Documentazione: Credit API
POST /rest/login Login (legacy) Endpoint legacy che restituisce una chiave API per integrazioni precedenti. Le nuove implementazioni dovrebbero usare direttamente l’autenticazione tramite chiave API.
Documentazione: Autenticazione API
POST /rest/logout Logout (legacy) Endpoint legacy che termina una sessione legacy.

Usa Swagger UI per il contratto REST completo, inclusi parametri, modelli e dettagli aggiornati di schema richiesta e risposta.

Operazioni API SOAP#

Le chiamate SOAP sono definite da endpoint del servizio + operazione + SOAPAction. Tutte le operazioni vengono invocate tramite HTTP POST sull’endpoint del servizio SOAP TrackRoad.

Autenticazione: Per le richieste SOAP, includi SessionIDHeader e imposta SessionID con la tua chiave API (TrackServiceKey). Login e Logout sono legacy e non necessari per le nuove integrazioni.

Endpoint del servizio Operazione SOAPAction Descrizione
/TrackService.asmx Dispatch http://TrackService.TrackRoad.com/Dispatch Esegue dispatch e ottimizzazione di grandi elenchi di fermate su più veicoli per workflow di ottimizzazione percorsi.
Documentazione: Dispatch API
/TrackService.asmx Geocode http://TrackService.TrackRoad.com/Geocode Accetta un elenco di indirizzi o località e restituisce fermate geocodificate con latitudine, longitudine e match code opzionali.
Documentazione: Geocoding API
/TrackService.asmx CalculateRoute http://TrackService.TrackRoad.com/CalculateRoute Genera indicazioni turn-by-turn e mappe di percorso per un singolo itinerario.
Documentazione: Route API
/TrackService.asmx CalculateRoutes http://TrackService.TrackRoad.com/CalculateRoutes Genera indicazioni e mappe per più percorsi, inclusa una mappa complessiva di tutti i percorsi.
Documentazione: Routes API
/TrackService.asmx CalculateDistance http://TrackService.TrackRoad.com/CalculateDistance Restituisce distanza di guida e tempo di percorrenza dal punto A al punto B.
/TrackService.asmx CreditRemaining http://TrackService.TrackRoad.com/CreditRemaining Restituisce il numero di crediti rimanenti dell’account.
Documentazione: Credit API
/TrackService.asmx GetRouteList http://TrackService.TrackRoad.com/GetRouteList Restituisce un elenco dei percorsi creati in un account, con filtri come intervallo di date, proprietario e nome percorso.
/TrackService.asmx GetRoute http://TrackService.TrackRoad.com/GetRoute Restituisce un percorso tramite RouteID.
/TrackService.asmx GetTrack http://TrackService.TrackRoad.com/GetTrack Accetta FromDate e ToDate in UTC e restituisce coordinate GPS con timestamp UTC per il periodo selezionato.
/TrackService.asmx Login http://TrackService.TrackRoad.com/Login Autenticazione legacy basata su sessione. Le nuove integrazioni dovrebbero inviare TrackServiceKey come SessionIDHeader e SessionID.
Documentazione: Autenticazione API
/TrackService.asmx Logout http://TrackService.TrackRoad.com/Logout Termina una sessione SOAP legacy.

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

Autenticazione REST (X-API-Key)#

Per le richieste REST, invia la tua chiave API (TrackServiceKey) nell’header X-API-Key in ogni richiesta.

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

Conserva le chiavi API lato server. Non incorporare le chiavi nel codice browser o mobile client.

Autenticazione SOAP (SessionIDHeader)#

Per le richieste SOAP, includi SessionIDHeader e imposta SessionID con la tua chiave API (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>

Imposta l’header HTTP SOAPAction corretto per ogni operazione SOAP quando chiami l’API SOAP di TrackRoad.

Login / Logout (legacy)#

Avviso legacy: Login e Logout restano documentati per integrazioni precedenti, ma non sono necessari per nuove implementazioni. Le nuove integrazioni dovrebbero usare una chiave API (TrackServiceKey) generata nell’account TrackRoad.

  • Preferito: autenticazione con chiave API — Autenticazione API
  • Legacy: REST /rest/login, /rest/logout e SOAP Login / Logout.

Best practice di sicurezza#

  • Non incorporare mai chiavi API in codice lato client come app web o mobili. Conserva le chiavi lato server.
  • Usa solo HTTPS per tutte le richieste API TrackRoad.
  • Ruota le chiavi se esposte e limita chi ha accesso alle credenziali di produzione.
  • Evita di registrare segreti come header, chiavi API o payload completi contenenti dati sensibili.

Errori comuni di autenticazione#

  • 401 / Unauthorized: header X-API-Key mancante o non valido per REST, oppure SessionIDHeader mancante o non valido per SOAP.
  • 403 / Forbidden: la chiave è valida ma bloccata, scaduta o senza credito.

FAQ#

Come posso autenticarmi con l’API REST di TrackRoad?
Invia la tua chiave API (TrackServiceKey) nell’header X-API-Key in ogni richiesta REST.
Come posso autenticarmi con l’API SOAP di TrackRoad?
Includi SessionIDHeader nelle richieste SOAP e imposta SessionID con la tua chiave API (TrackServiceKey). Login e Logout sono legacy e non necessari per nuove integrazioni.
Ho ancora bisogno di Login e Logout?
No per le nuove integrazioni. Le moderne integrazioni TrackRoad dovrebbero usare l’autenticazione tramite chiave API. Login e Logout restano disponibili per compatibilità con implementazioni precedenti.
Dove posso trovare il contratto completo dell’API REST?
Usa Swagger UI per consultare l’elenco completo degli endpoint REST, dei parametri, dei modelli di richiesta e dei modelli di risposta.

Pronto a sviluppare con TrackRoad?

Genera la tua chiave API (TrackServiceKey), poi esplora il contratto REST completo in Swagger oppure continua con la documentazione Dispatch API.

Ottieni chiave API Apri Swagger UI