Suppliers API
cetb-api-suppliers es una API NestJS para administrar proveedores asociados a un tenant. El servicio expone endpoints REST para crear, listar, consultar, actualizar y eliminar proveedores en MongoDB.
Stack técnico
| Componente | Uso |
|---|---|
| Node.js | Runtime de la aplicación |
| NestJS 11 | Framework HTTP y modularización |
| Mongoose 8 | Acceso a MongoDB |
| MongoDB | Persistencia en la colección suppliers |
| AWS Lambda | Entrada serverless mediante @vendia/serverless-express |
Responsabilidades principales
- Administrar proveedores por
tenantId. - Mantener datos comerciales, contacto y facturación del proveedor.
- Permitir búsqueda por nombre, contacto, email, teléfono o RFC/tax ID.
- Restringir lectura, actualización y borrado usando combinación de
idytenantId. - Exponer health checks globales y del módulo de proveedores.
Rutas principales
| Método | Ruta | Descripción |
|---|---|---|
GET |
/health |
Health check del servicio |
GET |
/suppliers/health |
Health check del módulo Suppliers |
POST |
/suppliers |
Crea un proveedor |
GET |
/suppliers?tenantId=...&search=... |
Lista proveedores de un tenant |
GET |
/suppliers/:id?tenantId=... |
Obtiene un proveedor por ID |
PATCH |
/suppliers/:id |
Actualiza parcialmente un proveedor |
DELETE |
/suppliers/:id?tenantId=... |
Elimina un proveedor |
Criterios de documentación
Esta documentación se generó tomando como fuente la rama main del repositorio cetb-api-suppliers.
No se consideran:
- Cambios locales sin commit.
- Cambios de ramas distintas a
main. - Archivos de Docker usados sólo para ambientes de desarrollo.
- Secretos, credenciales o URLs de conexión a servicios internos.