Documentación de API

Referencia técnica para integrar con Nova WMS. La API es REST, devuelve JSON y está montada bajo el prefijo /api.

Base URL y convenciones

Todas las rutas cuelgan de /api. Las respuestas son JSON; los errores siguen el formato estándar de NestJS con statusCode, message y error.

GET /api/productos
Content-Type: application/json

Autenticación por sesión

Las aplicaciones web usan la sesión de better-auth por cookie. Inicia sesión y envía las credenciales con cada petición (credentials: "include").

POST /api/auth/sign-in/email
{
  "email": "usuario@empresa.com",
  "password": "••••••••"
}

Autenticación por API key

Para integraciones server-to-server usa una API key en el header Authorization. Las API keys se crean desde el panel de administración en Super Admin → API Users.

curl https://tu-dominio/api/productos \
  -H "Authorization: Bearer <API_KEY>"

Cada API key está asociada a un usuario técnico (api user) con los permisos configurados por el administrador.

Paginación

Los listados aceptan page y pageSize (máx. 500) y, cuando aplica, search. La respuesta incluye metadatos de paginación.

GET /api/productos?page=1&pageSize=20&search=caja

{
  "data": [ /* ... */ ],
  "total": 134,
  "page": 1,
  "pageSize": 20,
  "totalPages": 7
}

Endpoints principales

Recursos disponibles bajo /api:

GET/api/productosListado de productos del catálogo

GET/api/clientesClientes del tenant

GET/api/bodegasBodegas del tenant

GET/api/inventarioStock actual por producto y ubicación

GET/api/pedidosPedidos de despacho

GET/api/recepcionesRecepciones registradas

GET/api/despachosDespachos realizados

GET/api/facturasFacturas emitidas

GET/api/pre-alertasPre-alertas de ingreso

Consulta la referencia interactiva (Swagger) para ver todos los endpoints, parámetros y esquemas de respuesta.

Errores

Los errores usan códigos HTTP estándar y un cuerpo descriptivo.

HTTP/1.1 404 Not Found
{
  "statusCode": 404,
  "message": "Producto no encontrado",
  "error": "Not Found"
}