Visão geral
A API do FleetZip é REST, autenticada por token e documentada em OpenAPI 3.1. Tudo o que a plataforma faz pela interface também é possível pela API.
- Pedidos — crie, atualize e consulte pedidos a roteirizar.
- Rotas — dispare a otimização, consulte sequências e acompanhe o progresso.
- Eventos — receba webhooks de saída, parada, ocorrência, entrega e devolução.
Imagem a inserir
Diagrama de integração: à esquerda os sistemas do cliente (ERP, TMS, e-commerce); ao centro o FleetZip (API REST + fila de webhooks); à direita o app do motorista e a torre de controle.
Webhooks por evento
Configure endpoints para receber notificações em tempo real. Cada evento traz o payload completo e é reentregue automaticamente em caso de falha:
| Evento | Quando dispara |
|---|---|
route.dispatched | Rota despachada para o app do motorista |
stop.arrived | Motorista chegou na parada |
delivery.completed | Entrega concluída com comprovante |
occurrence.created | Ocorrência registrada (recusa, ausente…) |
return.created | Devolução coletada |
SDKs oficiais
Bibliotecas para acelerar a integração, com autenticação, retentativas e validação de webhook já inclusas:
- Node, Python e Java — wrappers tipados sobre a API REST.
Imagem a inserir
Trecho de código mostrando a criação de um pedido via SDK Node e o recebimento de um webhook de entrega concluída.
Para um guia passo a passo, veja a documentação.