Skip to main content

Preguntas frecuentes (FAQ)

¿Qué es apolo-app-platcom-platform?​

Es una plataforma regional de seguridad, auditoría y observabilidad, diseñada para centralizar los eventos relevantes de los sistemas del ecosistema Cencosud, asegurando trazabilidad, control y cumplimiento.

Más detalles en la Introducción.

¿Qué problemas resuelve?​

  • Centraliza la auditoría de acciones de usuarios, roles y sistemas.
  • Estandariza el modelo de eventos de seguridad mediante una librería compartida.
  • Permite a los equipos de seguridad consultar, filtrar y descargar reportes de actividad.
  • Facilita el cumplimiento de políticas internas y normativas de compliance.

¿Qué servicios backend existen actualmente?​

Los principales servicios en el monorepo son:

  • bff-api – Backend for Frontend (orquestador de APIs y punto de entrada del portal).
  • auth-api – Autenticación y gestión de sesiones.
  • applications-api – Gestión de aplicaciones/módulos.
  • core-api – Lógica de dominio central.
  • reports-api – Generación y orquestación de reportes.
  • tenants-api – Multi-tenant y segmentación por organización/cliente.

La descripción detallada de cada uno se encuentra en Estructura del Backend.

¿Dónde se documentan los endpoints?​

Toda la documentación unificada de endpoints se expone a través del Swagger del BFF:

  • El BFF agrega y publica los endpoints de los distintos servicios.
  • Desde allí se puede explorar, probar y entender el modelo de contratos.

Ver APIs y Swagger para más detalles.

¿Cómo levanto el entorno local?​

Pasos generales:

  1. Clonar el repositorio.
  2. Configurar autenticación con GitHub Packages (GITHUB_TOKEN).
  3. Instalar dependencias (npm install).
  4. Levantar infraestructura con Docker (docker compose up -d).
  5. Ejecutar los servicios necesarios con npx nx serve <app>.

La guía paso a paso está en Desarrollo → Setup.

¿Cómo se prueban los endpoints?​

Hay tres caminos principales:

  • Swagger del BFF: para explorar y probar rápidamente los endpoints.
  • Bruno: colecciones organizadas por dominio (AUTH, APPLICATIONS, REPORTS, etc.).
  • Postman: colecciones equivalentes en JSON para equipos que utilicen esta herramienta.

Ver:

¿Qué es la librería de auditoría y quién la usa?​

Es una librería compartida (SDK) que expone funciones tipadas para publicar eventos de auditoría hacia Kafka.
Los sistemas del ecosistema Cencosud que necesiten reportar acciones de seguridad deben integrarse con esta librería siguiendo los lineamientos definidos en la documentación de integración (pendiente de publicar en una sección específica de librerías).

¿Cómo se gestionan los secretos y variables de entorno?​

Se utiliza Seki junto con el archivo config/.secretsrc.json para declarar todos los secretos y variables.
Al ejecutar targets como serve, build, lint o test, se genera un archivo src/config/secrets.ts en cada proyecto.

Más detalles en Desarrollo → Secretos.

¿Cómo contribuyo al proyecto?​

Debes seguir las guías de:

  • Estilo de código (ESLint + Prettier).
  • Mensajes de commit.
  • Flujo de ramas y pull requests.

Ver la sección Contribuir.

¿A quién contacto si tengo dudas?​

Según el tipo de consulta:

  • Funcional / negocio: equipo de producto / seguridad.
  • Arquitectura / diseño técnico: equipo de arquitectura o maintainers del repo.
  • CI/CD / infraestructura: equipo de DevOps / plataforma.