Bienvenida

La API de Routal es una interfaz REST/JSON servida desde https://api.routal.com. Cada petición se autentica con un query parameter private_key, cada respuesta es JSON, y cada endpoint está documentado y versionado.

Empieza aquí

• Quickstart — pasa de cero a una llamada exitosa a la API en menos de cinco minutos.
• Integra con IA — un bloque de contexto pegable para que Claude / Cursor / Copilot produzca código correcto de Routal a la primera.
• Recetas — walkthroughs end-to-end y ejecutables para los escenarios de integración más comunes (TS + Python + cURL).
• Authentication — cómo funcionan las API keys, dónde generarlas y cómo rotarlas.
• Errors — cada HTTP status, cada machine code, y qué hacer con cada uno.
• Rate limits — cuotas, headers y backoff recomendado.
• Webhooks — suscríbete a eventos de ciclo de vida de plans, routes y stops.

El modelo de recursos

Cuatro recursos cubren el dominio principal:

• Plans — agrupan stops, routes y vehicles para una ventana de entrega. Crea, optimiza y despacha plans programáticamente.
• Routes — secuencia ordenada de stops servida por un único vehicle. Recupera, modifica y despacha rutas.
• Stops — tareas individuales de entrega o servicio. Crea, actualiza, mueve entre rutas y geocodifica direcciones.
• Vehicles — recursos de flota que ejecutan rutas. Gestiona capacidad, habilidades y turnos.

Explora cada uno en la API Reference del sidebar.

Convenciones

• Todos los timestamps son ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) en UTC.
• Las coordenadas usan { lat, lng } en grados decimales WGS 84.
• Los IDs son strings hex de 24 caracteres.
• La paginación usa ?offset=N&limit=M. Las respuestas incluyen total.

Estado y soporte

• Estado operacional: routal.statuspage.io
• Seguridad y cumplimiento: trust.routal.com
• Artículos para developers: Routal support — colección developers