Boas-vindas

A API da Routal é uma interface REST/JSON servida em https://api.routal.com. Toda requisição é autenticada com um query parameter private_key, toda resposta é JSON, e todo endpoint é documentado e versionado.

Comece aqui

• Quickstart — vá do zero a uma chamada de API bem-sucedida em menos de cinco minutos.
• Integrar com IA — um bloco de contexto colável para que Claude / Cursor / Copilot produzam código correto da Routal de primeira.
• Receitas — walkthroughs end-to-end e executáveis para os cenários de integração mais comuns (TS + Python + cURL).
• Authentication — como funcionam as API keys, onde gerá-las e como rotacioná-las.
• Errors — cada HTTP status, cada machine code, e o que fazer com cada um.
• Rate limits — cotas, headers e backoff recomendado.
• Webhooks — assine eventos de ciclo de vida de plans, routes e stops.

O modelo de recursos

Quatro recursos cobrem o domínio principal:

• Plans — agrupam stops, routes e vehicles para uma janela de entrega. Crie, otimize e despache plans programaticamente.
• Routes — sequência ordenada de stops atribuída a um único vehicle. Recupere, altere e despache rotas.
• Stops — tarefas individuais de entrega ou serviço. Crie, atualize, mova entre rotas e geocodifique endereços.
• Vehicles — recursos de frota que executam rotas. Gerencie capacidade, habilidades e turnos.

Explore cada um na API Reference do sidebar.

Convenções

• Todos os timestamps são ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) em UTC.
• Coordenadas usam { lat, lng } em graus decimais WGS 84.
• IDs são strings hex de 24 caracteres.
• A paginação usa ?offset=N&limit=M. As respostas incluem total.

Status e suporte

• Status operacional: routal.statuspage.io
• Segurança e conformidade: trust.routal.com
• Artigos para developers: Routal support — coleção developers