Versão Autor Data Ação
1.0 Clivya Guedes 10 de out. de 2024 Inicio da documentação
1.1 Clivya Guedes 02 de jun. de 2026 Ajustes na documentação

Descrição

A API Plannning é uma solução inovadora que transforma o planejamento logístico, facilitando a gestão de operações complexas. Com sua tecnologia avançada, ela otimiza itinerários, apresentando o sequenciamento mais eficiente de entregas para cada veículo.

Estruturada no padrão REST, a API utiliza requisições HTTP para retornar o JSON, comunicação síncrona.

A API Planning possibilita a troca de informações sobre operações de entrega, roteirização e gestão de recursos, resultando em uma operação mais ágil e eficaz.

Swagger: https://homol-planning-999887777735.southamerica-east1.run.app/swagger-ui.html#/planning-controller/planningUsingPOST

Funcionalidades

Funcionalidade Definição
Janela de atendimento Horário restrito para atendimento de uma visita
Latitude e longitude inicial
(geral e por veículo)
Localização de partida dos veículos
TME
(Tempo Máximo de Entregas = geral ou por veículo) Referente à jornada máximo do motorista
Início e Fim Atendimento
(geral ou por veículo) Referente ao expediente do motorista
Início Dinâmico
Indicar ao ptf-ses que o início da rota acontecerá de
acordo com o horário agendado para chegar ao
primeiro cliente. O ptf-ses irá calcular a distância
até o ponto e assim indicar que horas o veículo deve
sair do ponto de partida
Início CD e Retorno CD
(geral) Contabilizar tempo e km do ponto de partida e também até o ponto de retorno (final) da rota
Máximo de visitas (geral e por veículo) Estabelecer o máximo de paradas por rota
Placas dos veículos e suas capacidades (peso, volume
ou cubagem) Determinar quais veículos podem ser utilizados na
simulação e suas restrições de capacidade
Simular Ignorando Zonas Simular sem delimitação de espaços geográficos
definidos para atendimento dos clientes por região
Pernoite
Caso exista um cenário com rotas de mais de um dia,
para que assim se possa cadastrar o tempo de descanso do motorista
Tempo médio de visita (por segmento ou por cliente) Determinar a duração do atendimento do motorista
nas visitas a serem planejadas
Tempo médio de visita (por segmento ou por cliente) Determinar a duração do atendimento do motorista
nas visitas a serem planejadas
Prioridade de cliente
Indicar ao sistema que o cliente precisa ser atendido
com uma prioridade acima dos demais
Valor máximo das rotas
(dinheiro)
Hoje essa informação é vinculada ao tipo de veículo, que determina também o custo das rotas.
Determina no sistema que o veículos só pode trafegar
com até certo valor de mercadoria
Trabalhar com coleta e entrega Indicar ao sistema se está sendo realizada a inserção
de pedidos no veículo ou a retirada

Detalhamento dos Endpoints

Funcionalidade Definição Forma de Envio
Autenticação Permite gerar token de acesso para realizar as operações [POST] /api/authenticate
Planejamento dos Serviços Permite planejar os serviços [POST]
/api/planning/{companyCode}

Autenticação

[POST] /api/authenticate

Parâmetros de Requisição: Body

Campo Definição Obrigatório Observação
companyCode Código da empresa a ser vinculado com o mapa da região SIM String
operationCode CNPJ da empresa contratante dos serviços da Pathfind SIM String
userCode Código de autorização para acesso a integração, relacionada ao usuário de integração para a empresa contratante. SIM String
uuid Identificador de controle gerado pela Pathfind SIM String

Exemplo de Requisição: [POST] /api/authenticate