Resumen
Esta documentacion publica expone la API de Raul a partir del esquema OpenAPI servido por el backend productivo.Referencia API
Explora endpoints, esquemas y autenticacion desde la referencia generada.
Flujos comunes
Recorre autenticacion, clientes, contactos, GPS y suscripciones paso a paso.
Autenticacion
Aprende login, Bearer JWT, refresh y manejo de errores de acceso.
Modulos
Entiende que hace cada modulo principal antes de entrar al detalle de endpoints.
Endpoints clave
- Base URL:
https://api.raul.ugps.io - Health check:
https://api.raul.ugps.io/api/health - OpenAPI JSON:
https://api.raul.ugps.io/api/openapi.json
Health check
Verifica disponibilidad del backend productivo.
OpenAPI JSON
Fuente de verdad para la referencia tecnica de esta documentacion.
Introduccion API
Resumen de autenticacion, consumo y enlaces operativos.
Flujos comunes
Guias operativas para integraciones y recorridos frecuentes.
Modulos API
Panorama funcional de Auth, Clients, GPS, Subscriptions, Billing y Analytics.
Convenciones API
Paginacion, filtros, fechas, uploads, rutas legacy y recomendaciones globales.
Errores y reintentos
Que errores corregir, cuales reintentar y como observar fallos.
Clientes
Alta, consulta, direcciones y branding basico de clientes.
Contactos
Creacion, asociacion, roles funcionales, fotos y merge.
Inbox y Omnichannel
Inbox unificado, shared mailboxes, sync de email, WhatsApp y tags.
Ventas y cotizaciones
Quotes, pipeline, dispositivos cotizables, outreach IA y equipment sales.
GPS
Equipos, catalogos, inventario y vistas operativas.
Suscripciones
Planes, altas, transferencias, estados y reversiones.
Swagger reemplazado
/api/docs redirige a Mintlify y usa el esquema OpenAPI remoto.Notas de uso
- La referencia de endpoints se genera desde OpenAPI, no desde paginas MDX manuales.
- Si el backend agrega o cambia endpoints, la documentacion se actualiza desde
https://api.raul.ugps.io/api/openapi.json. api.ugps.ioqueda fuera de esta documentacion.