Resumen de la referencia API de TrackRoad

TrackRoad ofrece APIs REST y SOAP para ayudarte a crear aplicaciones de optimización de rutas, despacho multivehículo, geocodificación, routing y cálculo de ETA y distancias.

Usa este centro API para encontrar autenticación, URLs base del servicio y la lista de endpoints REST y operaciones SOAP disponibles para integraciones de routing y dispatch de TrackRoad.

Resumen de referencia API de TrackRoad con endpoints REST, operaciones SOAP y autenticación con TrackServiceKey
Resumen de referencia API: endpoints REST, operaciones SOAP y autenticación con TrackServiceKey.

Antes de empezar

¿Necesitas el contrato REST completo?

Swagger ofrece la lista completa de endpoints REST, parámetros, modelos de solicitud y modelos de respuesta para acelerar la integración con la API de TrackRoad.

Ver Swagger UI Dispatch API

Tabla de contenidos

  1. URLs base de REST y SOAP
  2. Endpoints de la API REST
  3. Operaciones de la API SOAP
  4. Autenticación REST (X-API-Key)
  5. Autenticación SOAP (SessionIDHeader)
  6. Login / Logout (heredado)
  7. Buenas prácticas de seguridad
  8. Errores comunes de autenticación
  9. FAQ

URLs base de REST y SOAP#

TrackRoad ofrece dos estilos de API: REST y SOAP. Todos los endpoints parten del mismo host de servicio.

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

Endpoints de la API REST#

Las llamadas REST se definen por método HTTP + endpoint. Este resumen ayuda a los desarrolladores a localizar rápidamente los endpoints de TrackRoad para dispatch, geocoding, routing, crédito y autenticación heredada.

Método HTTP Endpoint Operación Descripción
POST /rest/dispatch Dispatch Optimiza y despacha paradas entre varios vehículos, incluyendo orden de paradas, ETA, distancia, duración y paradas omitidas o no asignadas.
Documentación: Dispatch API
POST /rest/geocode Geocode Convierte direcciones en coordenadas de latitud y longitud, opcionalmente con puntuación de confianza de coincidencia.
Documentación: Geocoding API
POST /rest/route Route Calcula una ruta a partir de una secuencia de ubicaciones para casos de uso de routing, navegación y tiempo de viaje.
Documentación: Route API
POST /rest/routes Routes Calcula múltiples rutas en una sola solicitud para procesos de routing por lotes y planificación de flotas.
Documentación: Routes API
POST /rest/credit Credit Devuelve la cantidad de crédito restante disponible para la cuenta o integración de TrackRoad.
Documentación: Credit API
POST /rest/login Login (heredado) Endpoint heredado que devuelve una clave API para integraciones antiguas. Las nuevas implementaciones deben usar autenticación directa por clave API.
Documentación: Autenticación API
POST /rest/logout Logout (heredado) Endpoint heredado que finaliza una sesión heredada.

Usa Swagger UI para ver el contrato REST completo, incluidos parámetros, modelos y detalles actuales del esquema de solicitud y respuesta.

Operaciones de la API SOAP#

Las llamadas SOAP se definen por endpoint del servicio + operación + SOAPAction. Todas las operaciones se invocan mediante HTTP POST en el endpoint del servicio SOAP de TrackRoad.

Autenticación: Para las solicitudes SOAP, incluye SessionIDHeader y establece SessionID con tu clave API (TrackServiceKey). Login y Logout son heredados y no son necesarios para integraciones nuevas.

Endpoint del servicio Operación SOAPAction Descripción
/TrackService.asmx Dispatch http://TrackService.TrackRoad.com/Dispatch Despacha y optimiza grandes listas de paradas entre varios vehículos para flujos de optimización de rutas.
Documentación: Dispatch API
/TrackService.asmx Geocode http://TrackService.TrackRoad.com/Geocode Acepta una lista de direcciones o ubicaciones y devuelve paradas geocodificadas con latitud, longitud y códigos de coincidencia opcionales.
Documentación: Geocoding API
/TrackService.asmx CalculateRoute http://TrackService.TrackRoad.com/CalculateRoute Genera indicaciones giro a giro y mapas de ruta para una sola ruta.
Documentación: Route API
/TrackService.asmx CalculateRoutes http://TrackService.TrackRoad.com/CalculateRoutes Genera indicaciones y mapas para múltiples rutas, incluido un mapa general de todas las rutas.
Documentación: Routes API
/TrackService.asmx CalculateDistance http://TrackService.TrackRoad.com/CalculateDistance Devuelve la distancia de conducción y el tiempo de viaje desde el punto A al punto B.
/TrackService.asmx CreditRemaining http://TrackService.TrackRoad.com/CreditRemaining Devuelve la cantidad de crédito restante de la cuenta.
Documentación: Credit API
/TrackService.asmx GetRouteList http://TrackService.TrackRoad.com/GetRouteList Devuelve una lista de rutas creadas en una cuenta, con filtros como rango de fechas, propietario y nombre de ruta.
/TrackService.asmx GetRoute http://TrackService.TrackRoad.com/GetRoute Devuelve una ruta por RouteID.
/TrackService.asmx GetTrack http://TrackService.TrackRoad.com/GetTrack Acepta FromDate y ToDate en UTC y devuelve coordenadas GPS con marcas de tiempo UTC para el periodo seleccionado.
/TrackService.asmx Login http://TrackService.TrackRoad.com/Login Autenticación heredada basada en sesión. Las nuevas integraciones deben enviar TrackServiceKey como SessionIDHeader y SessionID.
Documentación: Autenticación API
/TrackService.asmx Logout http://TrackService.TrackRoad.com/Logout Finaliza una sesión SOAP heredada.

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

Autenticación REST (X-API-Key)#

Para las solicitudes REST, envía tu clave API (TrackServiceKey) en la cabecera X-API-Key en cada petición.

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

Mantén las claves API del lado del servidor. No insertes claves en código de navegador o clientes móviles.

Autenticación SOAP (SessionIDHeader)#

Para las solicitudes SOAP, incluye SessionIDHeader y establece SessionID con tu clave 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>

Configura la cabecera HTTP SOAPAction correcta para cada operación SOAP al llamar a la API SOAP de TrackRoad.

Login / Logout (heredado)#

Aviso heredado: Login y Logout siguen documentados para integraciones antiguas, pero no son necesarios en implementaciones nuevas. Las nuevas integraciones deben usar una clave API (TrackServiceKey) generada en la cuenta de TrackRoad.

  • Preferido: autenticación con clave API — Autenticación API
  • Heredado: REST /rest/login, /rest/logout y SOAP Login / Logout.

Buenas prácticas de seguridad#

  • Nunca incrustes claves API en código del lado del cliente como aplicaciones web o móviles. Mantén las claves del lado del servidor.
  • Usa solo HTTPS para todas las solicitudes a la API de TrackRoad.
  • Rota las claves si se exponen y limita quién tiene acceso a credenciales de producción.
  • Evita registrar secretos como cabeceras, claves API o payloads completos con datos sensibles.

Errores comunes de autenticación#

  • 401 / Unauthorized: Falta o no es válida la cabecera X-API-Key en REST, o falta o no es válido el SessionIDHeader en SOAP.
  • 403 / Forbidden: La clave es válida, pero está bloqueada, ha expirado o no tiene crédito.

FAQ#

¿Cómo me autentico con la API REST de TrackRoad?
Envía tu clave API (TrackServiceKey) en la cabecera X-API-Key en cada solicitud REST.
¿Cómo me autentico con la API SOAP de TrackRoad?
Incluye SessionIDHeader en las solicitudes SOAP y establece SessionID con tu clave API (TrackServiceKey). Login y Logout son heredados y no son necesarios para integraciones nuevas.
¿Todavía necesito Login y Logout?
No para integraciones nuevas. Las integraciones modernas de TrackRoad deben usar autenticación por clave API. Login y Logout se mantienen por compatibilidad con implementaciones anteriores.
¿Dónde puedo encontrar el contrato completo de la API REST?
Usa Swagger UI para consultar la lista completa de endpoints REST, parámetros, modelos de solicitud y modelos de respuesta.

¿Listo para desarrollar con TrackRoad?

Genera tu clave API (TrackServiceKey) y luego explora el contrato REST completo en Swagger o continúa con la documentación de Dispatch API.

Obtener clave API Ver Swagger UI