Construindo requisições para a Planning API
Antes de começar a usar a API, será necessário obter o token de autenticação.
Os seguintes headers serão necessários, onde a palavra token deverá ser substiuída pelo token obtido no processo de autenticação:
--header 'Content-Type: application/json' \ --header 'Authorization: Bearer token'
Em body serão enviados todos os parâmetros para resolver o problema logístico.
A Planning API trabalha de forma assíncrona. Ou seja, ao enviar o problema será retornado um ID. Com esse ID será possível consultar a resposta no futuro ou o status do processamento.
A API possui os seguintes endpoints, onde o termo {{planningId}} deve ser substítuido pelo ID do problema a ser consultado:
- https://api.maplink.global/planning/v1/problems – POST
Usado para enviar o problema logístico. Um ID será retornado para a consulta. - https://api.maplink.global/planning/v1/events?jobId={{planningId}} – GET
Retorna todos os estados desde o recebimento da requisição até o sua conclusão. - https://api.maplink.global/planning/v1/jobs/{{planningId}} – GET
Retorna o estado atual do processamento da requisição. - https://api.maplink.global/planning/v1/solutions/{{planningId}} – GET
Retorna o resultado do planejamento logístico.
Nota: Os IDs das soluções ficam disponíveis para consulta durante o prazo de 7 dias.