Acceso a la API
API disponibles
| API | Finalidad | Ámbito OAuth |
|---|---|---|
| API de registros de formación | Leer asignaciones, resultados de finalización, información de grupos y el estado opcional de las invitaciones. | training.read |
| API de usuarios | Leer alumnos con formación asignada, incluidas las fechas de registro, último acceso y última asignación. | training.read |
| API de grupos | Listar grupos del ámbito del cliente, incluidos los números de proveedor y el estado de archivo. | training.read |
| API de paquetes | Listar paquetes de formación y sus cursos. | training.read |
| API de certificados | Listar certificados emitidos y descargar sus PDF. | training.read |
| API de asignaciones | Asignar alumnos a un paquete por lotes. | assignments.write |
Acceso y permisos
Las API de lectura se limitan a la organización o grupo que aparece en la ruta de navegación de Acceso a la API. El sistema externo no puede ampliar el ámbito de lectura enviando otro identificador. Las asignaciones también requieren un paquete y grupo permitidos, pero consulta la advertencia sobre asignaciones existentes antes de conceder acceso de escritura a un cliente de grupo.
- Los administradores de organización, autores y administradores de autores pueden crear clientes para la organización seleccionada.
- Los administradores de grupo pueden crear clientes para un grupo que administren.
- Cuando cada grupo paga su propia suscripción, debe tener una cuenta de pago activa para utilizar la API.
El administrador que crea el cliente sigue siendo su propietario. Si pierde el permiso sobre la organización o el grupo, el cliente deja de funcionar. Las credenciales del grupo también dejan de funcionar si el grupo deja de cumplir los requisitos de acceso.
Los clientes de API son de solo lectura de forma predeterminada. Para permitir asignaciones, activa Asignar usuarios en el cliente, dentro de Clientes de API. Al desactivarlo, se bloquean las asignaciones incluso con tokens ya emitidos.
Credenciales
Crear un cliente de API
- Abre Acceso a la API para el ámbito correspondiente:
- Para la organización actual, abre el menú de la cuenta y selecciona Acceso a la API bajo el nombre de la organización.
- Para un grupo, abre Mis grupos, expande el grupo y selecciona Acceso a la API.
- Selecciona Crear cliente de API.
- Introduce un Nombre descriptivo para el sistema externo o entorno y selecciona Crear cliente de API.
- Copia el ID de cliente y el Secreto de cliente en el gestor de secretos del sistema externo antes de cerrar el cuadro de diálogo.
El secreto solo se muestra una vez. e-LearningCourses guarda una representación protegida y no puede volver a mostrar el secreto original. Si lo pierdes, regenéralo.
Gestionar clientes de API
Crea un cliente independiente para cada sistema externo y entorno.
Activa Asignar usuarios solo en los clientes que necesiten crear alumnos y asignar paquetes. Está desactivado de forma predeterminada.
- Regenerar secreto crea uno nuevo y revoca inmediatamente los tokens de la credencial anterior. Actualiza el sistema externo antes de que solicite otro token.
- Revocar desactiva permanentemente el cliente y revoca sus tokens actuales. Crea otro cliente si vuelves a necesitar acceso.
- Último uso indica la última emisión correcta de un token, no cada solicitud a la API.
Consulta Autenticación para intercambiar estas credenciales por un token de acceso.