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
- Entrevista E-Talent — 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 |
| 06 — Niveles | Niveles 1–3 sobre E-Modes; desbloqueo de funcionalidades |
| 07 — Usuarios | Un rol, una organización; registro o invitación |
| 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 — Entrevista E-Talent | Flujo de entrevista para eMode; webhook E-Talent |
Comienza por el Overview.
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) |