Introduccion

​

Endpoint base

La API productiva disponible para consumo esta en:

• 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

​

Como leer esta documentacion

Raul combina dos capas:

• Guia: explica dominios, flujos, decisiones de integracion y contexto de negocio
• API: muestra el contrato exacto generado desde OpenAPI

Regla simple:

• si buscas un endpoint puntual, entra a API
• si buscas entender que modulo o secuencia usar, empieza por Guia

​

Autenticacion

La API interna usa autenticacion Bearer con JWT. El portal cliente usa un flujo separado de magic link y token portal. Para detalles:

• Autenticacion
• Permisos y roles

​

Grupos funcionales actuales

​

Reglas practicas de integracion

• Prefiere rutas RESTful cuando exista una alternativa legacy equivalente.
• En modulos con gran volumen de datos, prefiere paginacion o cursor.
• Algunos recursos tienen alias legacy y modernos; confirma la opcion recomendada en la pestaña API.
• No asumas que toda ruta autenticada es admin-only: revisa Permisos y roles.
• Para agentes o automatizaciones, combina esta pagina con Guia para IA.

​

Punto de partida recomendado

Si estas integrando desde cero:

1. autentica con /api/better-auth/sign-in/email
2. valida la sesion con /api/auth/users/me
3. identifica el dominio funcional correcto en Mintlify
4. consume el endpoint exacto desde la pestaña API

​

Enlaces rapidos