Manual de Integración Mobile

Todo lo que tu app móvil necesita para consumir la API de TwiinsHRM — contratos, flujos y lógica de cliente.

Empezar por la autenticación Ver módulos

¿Qué es este manual?

No es solo un catálogo de endpoints. Cada módulo documenta tres cosas:

Contratos

Entrada, salida y enumerados de cada endpoint, extraídos de los DTOs reales del backend.

Flujos

El orden en el que se consumen las APIs, con diagramas de secuencia de cada operación.

Lógica de cliente

Qué debe mostrar u ocultar la app según los datos y estados que devuelve la API.

Multi-tenant + JWT

Autenticación basada en tenants y tokens JWT — la misma que usa el portal web.

Arquitectura general

flowchart LR
    APP[App móvil] -->|"Authorization: Bearer JWT<br/>x-tenant-id: alias"| GW[API Gateway<br/>api-v4.twiinshrm.com]
    GW --> API[th-core-api<br/>NestJS / AWS Lambda]
    API --> DB[(Base de datos<br/>del tenant)]
    API -.->|SSO opcional| KC[Keycloak<br/>auth.twiinshrm.com]

La API es multi-tenant: cada cliente (empresa) tiene su propio alias y su propia base de datos. Toda petición debe identificar el tenant con el header x-tenant-id, y ese valor debe coincidir con el claim tenant del JWT.

Cómo usar este manual

Lee Autenticación y Tenants y ambientes — sin esto ninguna petición funciona.
Revisa las Convenciones de la API — paginación, filtros, errores y enumerados.
Entra al módulo que vas a implementar y sigue su flujo documentado.