Vue d’ensemble de la référence API TrackRoad

TrackRoad fournit des API REST et SOAP pour vous aider à créer des applications de optimisation de tournées, dispatch multi-véhicules, géocodage, routing ainsi que de calcul d’ETA et de distances.

Utilisez ce hub API pour trouver l’authentification, les URL de base du service et la liste des endpoints REST et opérations SOAP disponibles pour les intégrations de routing et de dispatch TrackRoad.

Vue d’ensemble de la référence API TrackRoad présentant les endpoints REST, les opérations SOAP et l’authentification avec TrackServiceKey
Vue d’ensemble de la référence API : endpoints REST, opérations SOAP et authentification avec TrackServiceKey.

Avant de commencer

Besoin du contrat REST complet ?

Swagger fournit la liste complète des endpoints REST, des paramètres, des modèles de requête et des modèles de réponse pour accélérer l’intégration de l’API TrackRoad.

Voir Swagger UI Dispatch API

Table des matières

  1. URL de base REST et SOAP
  2. Endpoints de l’API REST
  3. Opérations de l’API SOAP
  4. Authentification REST (X-API-Key)
  5. Authentification SOAP (SessionIDHeader)
  6. Login / Logout (hérité)
  7. Bonnes pratiques de sécurité
  8. Erreurs d’authentification courantes
  9. FAQ

URL de base REST et SOAP#

TrackRoad propose deux styles d’API : REST et SOAP. Tous les endpoints partagent le même hôte de service.

API URL
URL de base https://trackservice.trackroad.com
URL de base REST https://trackservice.trackroad.com/rest
Endpoint du service SOAP https://trackservice.trackroad.com/TrackService.asmx

Endpoints de l’API REST#

Les appels REST sont définis par la méthode HTTP + l’endpoint. Cette vue d’ensemble aide les développeurs à trouver rapidement les endpoints TrackRoad pour le dispatch, le géocodage, le routing, le crédit et l’authentification héritée.

Méthode HTTP Endpoint Opération Description
POST /rest/dispatch Dispatch Optimisez et dispatchez des arrêts sur plusieurs véhicules, y compris l’ordre des arrêts, l’ETA, la distance, la durée et les arrêts ignorés ou non affectés.
Documentation : Dispatch API
POST /rest/geocode Geocode Convertissez des adresses en coordonnées latitude/longitude, avec éventuellement un score de confiance de correspondance.
Documentation : Geocoding API
POST /rest/route Route Calculez un itinéraire à partir d’une séquence de lieux pour des cas d’usage de routing, navigation et temps de trajet.
Documentation : Route API
POST /rest/routes Routes Calculez plusieurs itinéraires en une seule requête pour les workflows de routing par lot et de planification de flotte.
Documentation : Routes API
POST /rest/credit Credit Retourne le nombre de crédits restants disponibles pour le compte ou l’intégration TrackRoad.
Documentation : Credit API
POST /rest/login Login (hérité) Endpoint hérité qui renvoie une clé API pour les anciennes intégrations. Les nouvelles implémentations doivent utiliser directement l’authentification par clé API.
Documentation : Authentification API
POST /rest/logout Logout (hérité) Endpoint hérité qui met fin à une session héritée.

Utilisez Swagger UI pour le contrat REST complet, y compris les paramètres, les modèles et les détails actuels des schémas de requête et de réponse.

Opérations de l’API SOAP#

Les appels SOAP sont définis par l’endpoint du service + l’opération + SOAPAction. Toutes les opérations sont invoquées via HTTP POST sur l’endpoint du service SOAP TrackRoad.

Authentification : Pour les requêtes SOAP, incluez SessionIDHeader et définissez SessionID avec votre clé API (TrackServiceKey). Login et Logout sont hérités et ne sont pas nécessaires pour les nouvelles intégrations.

Endpoint du service Opération SOAPAction Description
/TrackService.asmx Dispatch http://TrackService.TrackRoad.com/Dispatch Dispatchez et optimisez de grandes listes d’arrêts sur plusieurs véhicules pour des workflows d’optimisation de tournées.
Documentation : Dispatch API
/TrackService.asmx Geocode http://TrackService.TrackRoad.com/Geocode Accepte une liste d’adresses ou de lieux et renvoie des arrêts géocodés avec latitude, longitude et codes de correspondance facultatifs.
Documentation : Geocoding API
/TrackService.asmx CalculateRoute http://TrackService.TrackRoad.com/CalculateRoute Générez des indications détaillées et des cartes pour un itinéraire unique.
Documentation : Route API
/TrackService.asmx CalculateRoutes http://TrackService.TrackRoad.com/CalculateRoutes Générez des indications et des cartes pour plusieurs itinéraires, y compris une carte globale de toutes les tournées.
Documentation : Routes API
/TrackService.asmx CalculateDistance http://TrackService.TrackRoad.com/CalculateDistance Retourne la distance de conduite et le temps de trajet du point A au point B.
/TrackService.asmx CreditRemaining http://TrackService.TrackRoad.com/CreditRemaining Retourne le nombre de crédits restants pour le compte.
Documentation : Credit API
/TrackService.asmx GetRouteList http://TrackService.TrackRoad.com/GetRouteList Retourne une liste des tournées créées dans un compte, avec des filtres tels que la plage de dates, le propriétaire et le nom de la tournée.
/TrackService.asmx GetRoute http://TrackService.TrackRoad.com/GetRoute Retourne une tournée par RouteID.
/TrackService.asmx GetTrack http://TrackService.TrackRoad.com/GetTrack Accepte FromDate et ToDate en UTC et renvoie les coordonnées GPS avec horodatages UTC pour la période sélectionnée.
/TrackService.asmx Login http://TrackService.TrackRoad.com/Login Authentification héritée basée sur session. Les nouvelles intégrations doivent envoyer TrackServiceKey comme SessionIDHeader et SessionID.
Documentation : Authentification API
/TrackService.asmx Logout http://TrackService.TrackRoad.com/Logout Met fin à une session SOAP héritée.

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

Authentification REST (X-API-Key)#

Pour les requêtes REST, envoyez votre clé API (TrackServiceKey) dans l’en-tête X-API-Key à chaque requête.

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

Conservez les clés API côté serveur. N’intégrez pas les clés dans le code navigateur ou mobile.

Authentification SOAP (SessionIDHeader)#

Pour les requêtes SOAP, incluez SessionIDHeader et définissez SessionID avec votre clé 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>

Définissez le bon en-tête HTTP SOAPAction pour chaque opération SOAP lors de l’appel de l’API SOAP TrackRoad.

Login / Logout (hérité)#

Avis hérité : Login et Logout restent documentés pour les anciennes intégrations, mais ils ne sont pas requis pour les nouvelles implémentations. Les nouvelles intégrations doivent utiliser une clé API (TrackServiceKey) générée dans le compte TrackRoad.

  • Préféré : authentification par clé API — Authentification API
  • Hérité : REST /rest/login, /rest/logout et SOAP Login / Logout.

Bonnes pratiques de sécurité#

  • N’intégrez jamais les clés API dans du code côté client comme les applications web ou mobiles. Conservez les clés côté serveur.
  • Utilisez uniquement HTTPS pour toutes les requêtes API TrackRoad.
  • Faites tourner les clés si elles sont exposées et limitez l’accès aux identifiants de production.
  • Évitez d’enregistrer des secrets comme les en-têtes, les clés API ou les payloads complets contenant des données sensibles.

Erreurs d’authentification courantes#

  • 401 / Unauthorized : en-tête X-API-Key manquant ou invalide pour REST, ou SessionIDHeader manquant ou invalide pour SOAP.
  • 403 / Forbidden : la clé est valide mais bloquée, expirée ou sans crédit.

FAQ#

Comment m’authentifier avec l’API REST TrackRoad ?
Envoyez votre clé API (TrackServiceKey) dans l’en-tête X-API-Key à chaque requête REST.
Comment m’authentifier avec l’API SOAP TrackRoad ?
Incluez SessionIDHeader dans les requêtes SOAP et définissez SessionID avec votre clé API (TrackServiceKey). Login et Logout sont hérités et ne sont pas nécessaires pour les nouvelles intégrations.
Ai-je encore besoin de Login et Logout ?
Non pour les nouvelles intégrations. Les intégrations modernes TrackRoad doivent utiliser l’authentification par clé API. Login et Logout restent disponibles pour la compatibilité avec les anciennes implémentations.
Où trouver le contrat complet de l’API REST ?
Utilisez Swagger UI pour parcourir la liste complète des endpoints REST, des paramètres, des modèles de requête et des modèles de réponse.

Prêt à développer avec TrackRoad ?

Générez votre clé API (TrackServiceKey), puis explorez le contrat REST complet dans Swagger ou poursuivez avec la documentation Dispatch API.

Obtenir la clé API Voir Swagger UI