Visão Geral da Referência da API TrackRoad

A TrackRoad fornece APIs REST e SOAP para o ajudar a criar aplicações de otimização de rotas, despacho multi-veículo, geocodificação, roteamento e cálculo de ETA e distâncias.

Utilize este centro da API para encontrar autenticação, URLs base do serviço e a lista de endpoints REST e operações SOAP disponíveis para integrações de roteamento e despacho TrackRoad.

Visão geral da referência da API TrackRoad mostrando endpoints REST, operações SOAP e autenticação com TrackServiceKey
Visão geral da referência da API: endpoints REST, operações SOAP e autenticação com TrackServiceKey.

Antes de começar

Precisa do contrato REST completo?

O Swagger fornece a lista completa de endpoints REST, parâmetros, modelos de pedido e modelos de resposta para uma integração mais rápida da API TrackRoad.

Ver Swagger UI API de Despacho

Índice

  1. URLs base REST e SOAP
  2. Endpoints da API REST
  3. Operações da API SOAP
  4. Autenticação REST (X-API-Key)
  5. Autenticação SOAP (SessionIDHeader)
  6. Login / Logout (legado)
  7. Boas práticas de segurança
  8. Erros comuns de autenticação
  9. Perguntas frequentes

URLs base REST e SOAP#

A TrackRoad disponibiliza dois estilos de API: REST e SOAP. Todos os endpoints têm origem no mesmo anfitrião de serviço.

API URL
URL base https://trackservice.trackroad.com
URL base REST https://trackservice.trackroad.com/rest
Endpoint do serviço SOAP https://trackservice.trackroad.com/TrackService.asmx

Endpoints da API REST#

As chamadas REST são definidas por método HTTP + endpoint. Esta visão geral ajuda os programadores a encontrar rapidamente endpoints TrackRoad de despacho, geocodificação, roteamento, crédito e autenticação legada.

Método HTTP Endpoint Operação Descrição
POST /rest/dispatch Despacho Otimize e despache paragens por vários veículos, incluindo ordem das paragens, ETA, distância, duração e paragens ignoradas ou não atribuídas.
Documentação: API de Despacho
POST /rest/geocode Geocodificação Converta endereços em coordenadas de latitude e longitude, opcionalmente com pontuação de confiança da correspondência.
Documentação: API de Geocodificação
POST /rest/route Rota Calcule uma rota a partir de uma sequência de localizações para casos de uso de roteamento, navegação e tempo de viagem.
Documentação: API de Rota
POST /rest/routes Rotas Calcule várias rotas num único pedido para fluxos de trabalho de roteamento em lote e planeamento de frotas.
Documentação: API de Rotas
POST /rest/credit Crédito Devolve a contagem de crédito restante disponível para a conta ou integração TrackRoad.
Documentação: API de Crédito
POST /rest/login Login (legado) Endpoint legado que devolve uma chave de API para integrações mais antigas. Novas implementações devem utilizar diretamente a autenticação por chave de API.
Documentação: Autenticação da API
POST /rest/logout Logout (legado) Endpoint legado que termina uma sessão legada.

Utilize Swagger UI para o contrato REST completo, incluindo parâmetros, modelos e detalhes atuais do esquema de pedido e resposta.

Operações da API SOAP#

As chamadas SOAP são definidas por endpoint do serviço + operação + SOAPAction. Todas as operações são invocadas via HTTP POST no endpoint do serviço SOAP da TrackRoad.

Autenticação: Para pedidos SOAP, inclua SessionIDHeader e defina SessionID para a sua Chave de API (TrackServiceKey). Login e Logout são legados e não são necessários para novas integrações.

Endpoint do serviço Operação SOAPAction Descrição
/TrackService.asmx Dispatch http://TrackService.TrackRoad.com/Dispatch Despache e otimize grandes listas de paragens por vários veículos para fluxos de trabalho de otimização de rotas.
Documentação: API de Despacho
/TrackService.asmx Geocode http://TrackService.TrackRoad.com/Geocode Aceite uma lista de endereços ou localizações e devolva paragens geocodificadas com latitude, longitude e códigos de correspondência opcionais.
Documentação: API de Geocodificação
/TrackService.asmx CalculateRoute http://TrackService.TrackRoad.com/CalculateRoute Gere direções passo a passo e mapas de rota para uma única rota.
Documentação: API de Rota
/TrackService.asmx CalculateRoutes http://TrackService.TrackRoad.com/CalculateRoutes Gere direções e mapas para múltiplas rotas, incluindo um mapa geral para todas as rotas.
Documentação: API de Rotas
/TrackService.asmx CalculateDistance http://TrackService.TrackRoad.com/CalculateDistance Devolve a distância de condução e o tempo de viagem do ponto A ao ponto B.
/TrackService.asmx CreditRemaining http://TrackService.TrackRoad.com/CreditRemaining Devolve a contagem de crédito restante da conta.
Documentação: API de Crédito
/TrackService.asmx GetRouteList http://TrackService.TrackRoad.com/GetRouteList Devolve uma lista de rotas criadas numa conta, com filtros como intervalo de datas, proprietário e nome da rota.
/TrackService.asmx GetRoute http://TrackService.TrackRoad.com/GetRoute Devolve uma rota por RouteID.
/TrackService.asmx GetTrack http://TrackService.TrackRoad.com/GetTrack Aceite FromDate e ToDate em UTC e devolva coordenadas GPS com carimbos temporais UTC para o período selecionado.
/TrackService.asmx Login http://TrackService.TrackRoad.com/Login Autenticação legada baseada em sessão. Novas integrações devem enviar TrackServiceKey como SessionIDHeader e SessionID.
Documentação: Autenticação da API
/TrackService.asmx Logout http://TrackService.TrackRoad.com/Logout Termina uma sessão SOAP legada.

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

Autenticação REST (X-API-Key)#

Para pedidos REST, envie a sua Chave de API (TrackServiceKey) no cabeçalho X-API-Key em todos os pedidos.

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

Mantenha as chaves de API no lado do servidor. Não incorpore chaves no código do browser ou da aplicação móvel.

Autenticação SOAP (SessionIDHeader)#

Para pedidos SOAP, inclua SessionIDHeader e defina SessionID para a sua Chave de 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>

Defina o cabeçalho HTTP SOAPAction correto para cada operação SOAP ao chamar a API SOAP da TrackRoad.

Login / Logout (legado)#

Aviso legado: Login e Logout continuam documentados para integrações mais antigas, mas não são necessários para novas implementações. Novas integrações devem utilizar uma Chave de API (TrackServiceKey) gerada na conta TrackRoad.

  • Preferido: autenticação por chave de API — Autenticação da API
  • Legado: REST /rest/login, /rest/logout e SOAP Login / Logout.

Boas práticas de segurança#

  • Nunca incorpore chaves de API em código do lado do cliente, como browsers ou aplicações móveis. Mantenha as chaves no lado do servidor.
  • Utilize apenas HTTPS para todos os pedidos à API TrackRoad.
  • Rode as chaves se forem expostas e limite quem tem acesso às credenciais de produção.
  • Evite registar segredos como cabeçalhos, chaves de API ou payloads completos que contenham dados sensíveis.

Erros comuns de autenticação#

  • 401 / Não autorizado: X-API-Key em falta ou inválido para REST, ou SessionIDHeader em falta ou inválido para SOAP.
  • 403 / Proibido: A chave é válida, mas está bloqueada, expirou ou ficou sem crédito.

Perguntas frequentes#

Como faço a autenticação na API REST TrackRoad?
Envie a sua chave de API (TrackServiceKey) no cabeçalho X-API-Key em todos os pedidos REST.
Como faço a autenticação na API SOAP TrackRoad?
Inclua SessionIDHeader nos pedidos SOAP e defina SessionID para a sua chave de API (TrackServiceKey). Login e Logout são legados e não são necessários para novas integrações.
Ainda preciso de Login e Logout?
Não para novas integrações. As integrações modernas da TrackRoad devem utilizar autenticação por chave de API. Login e Logout permanecem por compatibilidade retroativa com implementações mais antigas.
Onde posso encontrar o contrato completo da API REST?
Utilize Swagger UI para consultar a lista completa de endpoints REST, parâmetros, modelos de pedido e modelos de resposta.

Pronto para desenvolver com a TrackRoad?

Gere a sua Chave de API (TrackServiceKey) e depois explore o contrato REST completo no Swagger ou continue com a documentação da API de Despacho.

Obter Chave de API Ver Swagger UI