Customers API
cetb-api-customers es una API NestJS para administrar clientes asociados a un tenant. El servicio expone endpoints REST para crear, listar, consultar, actualizar, eliminar clientes e incrementar su contador de órdenes.
Stack Técnico
| Componente | Uso |
|---|---|
| Node.js | Runtime de la aplicación |
| NestJS 11 | Framework HTTP y modularización |
| Mongoose | Acceso a MongoDB |
| MongoDB | Persistencia en la colección customers |
| AWS Lambda | Entrada serverless mediante @vendia/serverless-express |
Responsabilidades Principales
- Administrar clientes por
tenantId. - Mantener datos de identificación, contacto, ciudad, estatus y segmento.
- Permitir búsqueda por nombre, apellido, email, teléfono o ciudad.
- Incrementar el contador
totalOrdersde un cliente. - Restringir consultas, actualizaciones y borrados usando combinación de
idytenantId.
Rutas Principales
| Método | Ruta | Descripción |
|---|---|---|
GET |
/health |
Health check del servicio |
POST |
/customers |
Crea un cliente |
GET |
/customers?tenantId=...&search=... |
Lista clientes de un tenant |
GET |
/customers/:id?tenantId=... |
Obtiene un cliente por ID |
PATCH |
/customers/:id?tenantId=... |
Actualiza parcialmente un cliente |
PATCH |
/customers/:id/orders/increment?tenantId=... |
Incrementa totalOrders |
DELETE |
/customers/:id?tenantId=... |
Elimina un cliente |
Criterios De Documentación
Esta documentación se generó tomando como fuente la rama main del repositorio cetb-api-customers.
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.