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

# Raul API

> Documentacion tecnica y referencia OpenAPI para la API de Raul

## Resumen

Esta documentacion publica expone la API de Raul a partir del esquema OpenAPI
servido por el backend productivo.

<Card title="Referencia API" icon="terminal" href="/api-reference/introduction" horizontal>
  Explora endpoints, esquemas y autenticacion desde la referencia generada.
</Card>

<Card title="Flujos comunes" icon="route" href="/common-workflows" horizontal>
  Recorre autenticacion, clientes, contactos, GPS y suscripciones paso a paso.
</Card>

<Card title="Autenticacion" icon="lock" href="/authentication" horizontal>
  Aprende login, Bearer JWT, refresh y manejo de errores de acceso.
</Card>

<Card title="Modulos" icon="boxes-stacked" href="/modules-overview" horizontal>
  Entiende que hace cada modulo principal antes de entrar al detalle de endpoints.
</Card>

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

<Columns cols={2}>
  <Card title="Health check" icon="heartbeat" href="https://api.raul.ugps.io/api/health">
    Verifica disponibilidad del backend productivo.
  </Card>

  <Card title="OpenAPI JSON" icon="file-json" href="https://api.raul.ugps.io/api/openapi.json">
    Fuente de verdad para la referencia tecnica de esta documentacion.
  </Card>

  <Card title="Introduccion API" icon="book-open-cover" href="/api-reference/introduction">
    Resumen de autenticacion, consumo y enlaces operativos.
  </Card>

  <Card title="Flujos comunes" icon="route" href="/common-workflows">
    Guias operativas para integraciones y recorridos frecuentes.
  </Card>

  <Card title="Modulos API" icon="boxes-stacked" href="/modules-overview">
    Panorama funcional de Auth, Clients, GPS, Subscriptions, Billing y Analytics.
  </Card>

  <Card title="Convenciones API" icon="scale-balanced" href="/api-conventions">
    Paginacion, filtros, fechas, uploads, rutas legacy y recomendaciones globales.
  </Card>

  <Card title="Errores y reintentos" icon="triangle-exclamation" href="/error-handling">
    Que errores corregir, cuales reintentar y como observar fallos.
  </Card>

  <Card title="Clientes" icon="building" href="/clients-guide">
    Alta, consulta, direcciones y branding basico de clientes.
  </Card>

  <Card title="Contactos" icon="address-book" href="/contacts-guide">
    Creacion, asociacion, roles funcionales, fotos y merge.
  </Card>

  <Card title="Inbox y Omnichannel" icon="inbox" href="/omnichannel-guide">
    Inbox unificado, shared mailboxes, sync de email, WhatsApp y tags.
  </Card>

  <Card title="Ventas y cotizaciones" icon="file-invoice-dollar" href="/sales-guide">
    Quotes, pipeline, dispositivos cotizables, outreach IA y equipment sales.
  </Card>

  <Card title="GPS" icon="satellite-dish" href="/gps-guide">
    Equipos, catalogos, inventario y vistas operativas.
  </Card>

  <Card title="Suscripciones" icon="arrows-rotate" href="/subscriptions-guide">
    Planes, altas, transferencias, estados y reversiones.
  </Card>

  <Card title="Swagger reemplazado" icon="arrows-rotate">
    `/api/docs` redirige a Mintlify y usa el esquema OpenAPI remoto.
  </Card>
</Columns>

## 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.io` queda fuera de esta documentacion.