Saiba os endpoints disponíveis e como enviar as requisições para a Trip API.
Antes de começar a usar a Trip API, é necessário utilizar a Authentication API para obter o token de autenficação.
Os seguintes headers são necessários:
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token'
Em body são enviados todos os parâmetros para resolver o cálculo da rota.
A Trip API pode trabalhar de duas formas: síncrona ou assíncrona.
Trip Síncrona
Com a Trip Síncrona é possível obter o resultado da roteirização em um única requisição. A Trip Síncrona possui os seguintes endpoints:
-
https://api.maplink.global/trip/v2/calculations - POST
Usado para enviar o problema logístico. O resultado completo da roteirização é retornado. -
https://api.maplink.global/trip/v1/solutions/ - GET
Retorna o resultado da roteirização conforme o ID informado. Para não precisar enviar a requisição novamente, você pode usar o ID da rota anteriormente para consulta.
As coordenadas da rota na Trip Síncrona serão retornadas no formato polyline para uma melhor performance. Isso pode ser alterado por parâmetro, conforme explicado no link.
Trip Assíncrona
Diferente da Trip Síncrona, ao enviar uma requisição para a Trip Assíncrona apenas o ID da rota será retornado para consulta futura. Ela também possui dois endpoints a mais que possibilitam conferir o status do processamento da requisição.
A Trip Assíncrona possui os seguintes endpoints:
-
https://api.maplink.global/trip/v1/problems - POST
Usado para enviar a rota a ser roteirizada. Um ID será retornado para a consulta. -
https://api.maplink.global/trip/v1/events?jobId= - GET
Retorna todos os estados desde o recebimento da requisição até o sua conclusão. -
https://api.maplink.global/trip/v1/jobs/ - GET
Retorna o estado atual do processamento da requisição. -
https://api.maplink.global/trip/v1/solutions/ - GET
Retorna o resultado da roteirização.
As coordenadas da rota na Trip Assíncrona serão retornadas em formato de objeto. Isso pode ser alterado por parâmetro, conforme explicado no link.
Nota: Os IDs das rotas ficam disponíveis para consulta durante o prazo de 7 dias. Caso você precise que a rota fique armazenada por mais tempo, confira o seguinte link para saber mais.