> ## Documentation Index
> Fetch the complete documentation index at: https://docs.raul.ugps.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduccion

> Documentacion oficial de la API de Raul

## 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`

## Autenticacion

Los endpoints protegidos usan autenticacion `Bearer` con token JWT. La
referencia de API indica que operaciones requieren autenticacion y los esquemas
de request y response asociados.

## Fuente de referencia

La pestaña de **API** renderiza automaticamente los endpoints definidos en el
esquema OpenAPI expuesto por el backend. Este documento no replica manualmente
los contratos; consume la definicion publicada por la API.

## Modulos disponibles

| Modulo               | Descripcion                                                              |
| -------------------- | ------------------------------------------------------------------------ |
| **Auth**             | Login, refresh, logout, gestion de usuarios, avatar, password reset      |
| **Clients**          | CRUD de clientes, paginacion, logo                                       |
| **Client Father**    | Clientes padre con suscripciones                                         |
| **Client Addresses** | Direcciones agrupadas por ciudad                                         |
| **Contact**          | Contactos, leads, functional roles, merge, fotos                         |
| **Vehicle / Asset**  | Vehiculos, filtros, tipos de vehiculo                                    |
| **Activities**       | Timeline por cliente/contacto/visita, archivos, tipos                    |
| **GPS Details**      | Equipos GPS con paginacion offset/cursor, IMEI, resumen                  |
| **GPS Catalogos**    | Modelos, plataformas, inventario, marcas, categorias, estados, historial |
| **Subscriptions**    | Suscripciones, planes, estados, monedas, transferencias                  |
| **Catalogos**        | Rubro, ciudad, tipo de contrato, cargo, comunicacion, lifecycle          |

## Rutas recomendadas

* Prefiere rutas RESTful cuando exista una alternativa legacy equivalente.
* En modulos con gran volumen de datos, prefiere endpoints paginados o cursor-based.
* Algunos endpoints tienen alias (ej: `/gps_details/...` y `/gps/...`); ambos son equivalentes.
* Usa esta documentacion junto con la guia de consumo para IA cuando el cliente
  sea un agente o automatizacion.

<Card title="Abrir JSON OpenAPI" icon="file-json" href="https://api.raul.ugps.io/api/openapi.json">
  Ver definicion completa de endpoints y esquemas
</Card>

<Card title="Ver health check" icon="heartbeat" href="https://api.raul.ugps.io/api/health">
  Confirmar disponibilidad operativa del backend
</Card>

<Card title="Guia para IA" icon="sparkles" href="/ai-consumption">
  Criterios para agentes, automatizaciones y consumo programatico
</Card>