e-training — Documentación
Bienvenido a la documentación de e-training-back, la API del sistema de formación (e-training).
¿Qué es e-training-back?
e-training-back es una API REST que gestiona usuarios, organizaciones, formación y recursos asociados. Expone operaciones que consumen clientes web, móvil u otros servicios y ofrece:
- Organizaciones — Tipos COMMON y SUPER_ADMIN, slug fiscal, contacto principal, usuarios y roles
- Permisos y roles — Control de acceso por recurso y acción; roles por organización
- Usuarios — Un rol y una organización; creación por registro de org o invitación; onboarding
- Registro e invitaciones — Alta de organización + primer usuario; invitaciones por email
- Autenticación — Login y renovación de tokens mediante refresh tokens
- Modos existenciales (E-Modes) — Asignación por test de onboarding o integración con E-Talent
- Niveles — Conocimiento sobre E-Modes (1–3); desbloqueo de funcionalidades; gestión por administrador
- E-Test Onboarding — Flujo de entrevista para determinar el eMode; webhook con E-Talent
Documentación funcional (DRF)
Los Documentos de Requisitos Funcionales describen qué hace el sistema desde la perspectiva del usuario: funcionalidades, casos de uso y comportamiento esperado. Pensada para producto, QA y desarrollo.
| Documento | Contenido |
|---|---|
| Overview | Visión general del sistema y capacidades principales |
| Sobre esta documentación | Propósito del DRF, organización y convenciones |
| 01 — Organizaciones | Tipos COMMON/SUPER_ADMIN, slug, contacto, usuarios, roles, estado |
| 02 — Permisos | Recurso + acción, lista cerrada, ORGANIZATION solo SUPER_ADMIN |
| 03 — Roles | Roles por organización |
| 05 — Modos existenciales | E-Modes; test onboarding, integración E-Talent |
| 05b — E-Mode editable desde el perfil | Anexo A-05 — el usuario ve y cambia su E-Mode; el E-Test como primera hipótesis. Propuesta |
| 06 — Niveles | Niveles 1–3 sobre E-Modes; desbloqueo de funcionalidades |
| 07 — Usuarios | Un rol, una organización; registro o invitación |
| 07b — Carga masiva de usuarios | Anexo A-07 — alta masiva por CSV; plantilla, vista previa y email de primer ingreso. Propuesta |
| 08 — Registro | Registro de organización + primer usuario |
| 09 — Invitaciones | Invitación por email; registro + onboarding del invitado |
| 10 — Autenticación | Login y renovación de tokens (refresh) |
| 11 — E-Test Onboarding | Flujo de entrevista para eMode; webhook E-Talent |
| 11b — Importación E-Test | Importación de E-Test Onboarding por un admin |
| 12 — Brun-E sesiones voz | Sesiones de voz con IA; flujo OpenAI Realtime |
| 12b — Base de conocimiento de Brun-E | Anexo B-12 — el material que Brun-E consulta en las conversaciones: qué ya funciona, sus límites y cómo sostenerlo. Documento de debate |
| 13 — E-map individual | Perfil existencial individual |
| 14 — E-map grupal | Perfil existencial grupal (vista del líder) |
| 14b — E-map grupal IA líder | Estrategia de contenido IA grupal para el líder |
| 14c — E-map organizacional | Perfil existencial organizacional (RRHH/Dirección) |
| 15 — Liderazgo | Relaciones líder-liderado |
| 16 — Notificaciones | Notificaciones in-app y email; comunicados masivos |
| 17 — Almacenamiento | Servicio de almacenamiento de archivos (avatares) |
| 18 — Cápsulas de entrenamiento | Contenido + consigna; ejercicio por formulario, Brun-E o E-Trainer. Propuesta |
| 19 — Brun-E multiagéntico | Anexo B-19 — cerebro general + especialistas consultables. Documento de debate |
| 20 — Gamificación | Puntos, insignias, hitos y rankings. Propuesta |
| 21 — Suscripciones y créditos | Planes por empresa, créditos y consumo. Propuesta |
| 22 — Marco teórico (biblioteca) | Contenido teórico que lee el usuario; índice ordenable, material con imágenes. Propuesta |
| 23 — Enlaces externos | Botones configurables en la sidebar (E-Session, forms); permiso de visibilidad y registro de clics. Propuesta |
Comienza por el Overview.
Planes de implementación
Documentos de diseño e implementación para funcionalidades en desarrollo o completadas.
| Plan | Descripción |
|---|---|
| Leadership module | Módulo de relaciones líder-liderado |
| Brun-E realtime (NAC-76) | Implementación Brun-E con OpenAI Realtime |
| Brun-E realtime design | Diseño técnico Brun-E Realtime |
| Brun-E global config | Configuración global de Brun-E |
| Brun-E report guaranteed | Garantía de entrega de reportes |
| Brun-E session report fix | Fix reporte de sesión no retornando |
Recursos
| Recurso | Descripción |
|---|---|
| Postman | Colección e importación para probar la API |
| API | Documentación interactiva en /api (con el servidor en marcha) |