Endpoints

Página puente a la referencia OpenAPI de la API. El playground interactivo Scalar y un resumen de las 49 familias de rutas REST.

La referencia endpoint-por-endpoint de la API se genera automáticamente desde su especificación OpenAPI. El playground interactivo de Scalar es la fuente de verdad para explorar y probar los endpoints; embeberlo en este sitio (con fumadocs-openapi) queda como siguiente paso opcional — ver Known issues.

Especificación OpenAPI

@nestjs/swagger construye la spec a partir de los decoradores de cada controller (@ApiTags, DTOs). Scalar la renderiza como playground en /docs:

Entorno	Playground
Producción	`https://api.valwisp.com/docs`
Desarrollo	`http://localhost:3000/docs`

Autentícate en el playground con un Bearer JWT válido (ver Autenticación). La ruta /docs en sí es pública, igual que /api/v1/health.

Familias de rutas

Todas las rutas cuelgan de /api/v1. Cada módulo registra su propio prefijo.

Núcleo de tenant

Rutas autenticadas con el JWT de staff, aisladas por tenantId.

Prefijo	Dominio
`auth`	Login, refresh, accept-invite, logout, `/me`
`tenants`	Gestión de tenants (ISPs) — solo Super Admin
`users`, `roles`	Usuarios internos y roles/permisos dinámicos (CASL)
`clients`	Suscriptores del ISP
`plans`	Planes de ancho de banda
`routers`, `ipv4-pools`, `hotspot`	Mikrotik, pools IPv4, hotspot
`internet-services`	Servicios PPPoE — provisioning, planes masivos, sync de dispositivos
`radius`	Hooks de FreeRADIUS + escritura directa en `radcheck`/`radreply`
`billing`, `invoices`, `payments`, `cash-sessions`	Facturación automática, facturas, pagos, sesiones de caja
`accounting`, `accounting/settings`, `accounting/reports`	Libro diario, posteo automático, estados financieros
`contracts`	Contratos de servicio + PDF
`tickets`	Soporte al cliente
`nap`, `zones`	Cajas NAP, zonas de cobertura
`installations`, `brigades`, `fuel`	Órdenes de instalación, brigadas de campo, combustible
`inventory`, `warehouses`	Almacén y ubicaciones
`monitoring`	Monitoreo en tiempo real (Socket.io + SNMP)
`branches`	Sucursales
`voip`	Servicios VoIP
`gamification`, `tasks`	Puntos/niveles y tareas asignables
`departments`, `time-entries`	Departamentos organizacionales, registro de horas
`templates`, `custom-fields`, `additional-services`, `announcements`	Plantillas, campos personalizados, servicios adicionales, anuncios
`changelog`, `chat`, `settings`	Novedades del producto, chat interno, configuración del tenant
`migration`	Importación/sync desde Mikrowisp
`tomoval`	Diseño de red FTTH (hilos, empalmes, splitters, colaboración en vivo)

ValStaff (RRHH)

Prefijo	Dominio
`valstaff/employees`, `valstaff/positions`, `valstaff/departments`, `valstaff/employee-types`	Empleados y estructura organizacional
`valstaff/leave`, `valstaff/leave-types`, `valstaff/dashboard`	Licencias/vacaciones y su dashboard

WhatsApp / ValChat

Prefijo	Dominio
`whatsapp`	Webhooks, media
`whatsapp/flows`, `whatsapp/tools`	Flujos de automatización y herramientas
`whatsapp/worker`	Worker interno de procesamiento
`valchat/channels`	Canales de chat multicanal + health-check

Público y pasarelas de pago

Sin autenticación de staff — pensadas para el cliente final o para webhooks externos.

Prefijo	Dominio
`public/invoices`	Consulta/pago público de una factura por token
`public/paypal`, `payment-gateways/azul`	Pasarelas de pago online
`agent` (bajo `agent-gateway`)	Gateway WebSocket del Agente Local + `GET /agent/downloads`

Infraestructura

Prefijo	Dominio
`health`	Healthcheck
`/docs`	Playground Scalar
`/openapi.json`	Spec OpenAPI cruda
`utils`	Utilidades varias (p. ej. validación de cédula/RNC)

Esta referencia se complementa con la documentación OpenAPI generada automáticamente. Para el contrato exacto de cada endpoint (parámetros, cuerpos y respuestas), consulta el playground Scalar y el *.controller.ts del módulo correspondiente en apps/valwisp-api/src/modules/.

Volver a API REST.