Este documento ofrece instrucciones para integrar la API de Canvas Instructure en la plataforma de video Lumina. Los administradores pueden integrar la API de Instructure Canvas y sincronizar automáticamente toda la información de Canvas con Lumina.
Generación del ID de cliente y las claves de API de Canvas
Las siguientes instrucciones permiten a los usuarios generar un nuevo ID de cliente y una nueva clave de API de Canvas que se pueden usar para la integración con Lumina.
- Inicie sesión en Canvas como administrador.
-
Vaya a la pestaña Administrador y elija Claves de desarrollador. Haga clic en el botón + Clave de desarrollador y seleccione + Clave de API.
-
Ingrese la información como se muestra a continuación y luego haga clic en Guardar.
- Nombre de la clave: Canvas Auto Sync Key
-
URI de redirección: https://<YOUR_YUJA_DOMAIN>/auth/Canvas
- Zona de EE. UU.: https://panorama-api.yuja.com/canvas-auth
- Zona de Canadá: https://panorama-api-cz.yuja.com/canvas-auth
- Zona de la UE: https://panorama-api-ez.yuja.com/canvas-auth
- Zona de Australia: https://panorama-api-az.yuja.com/canvas-auth
- (Opcional) Habilite Aplicar alcances.
Nota: No recomendamos aplicar alcances. Esto requerirá que vuelva a integrar Panorama con la API de Canvas cada vez que Panorama agregue nuevas funciones que utilicen la API. Si no desea continuar con esto, asegúrese de que Aplicar alcances esté deshabilitado.
Alcances recomendados:
Cuentas
url:GET|/api/v1/accounts
url:GET|/api/v1/accounts/:id
url:GET|/api/v1/accounts/:account_id/courses
url:GET|/api/v1/accounts/:account_id/sub_accountsAdministradores
url:GET|/api/v1/accounts/:account_id/adminsUsuarios
url:GET|/api/v1/accounts/:account_id/users
url:GET|/api/v1/users/:id/profileRoles
url:GET|/api/v1/accounts/:account_id/rolesInscripciones
url:GET|/api/v1/courses/:course_id/enrollmentsGrupos
url:GET|/api/v1/courses/:course_id/groups
url:GET|/api/v1/groups/:group_id/usersTareas
url:GET|/api/v1/courses/:course_id/assignments
url:GET|/api/v1/courses/:course_id/assignments/:id
-
Cambie el interruptor Estado a Activado y copie el ID de cliente de Canvas para usarlo más adelante.
-
A continuación, haga clic en Mostrar clave y copie la clave de API de Canvas para usarla más adelante.
Integración de la API de Canvas en la plataforma de video
Los siguientes pasos consisten en integrar la clave de API de Canvas recién obtenida en la plataforma de video.
-
Inicie sesión en la plataforma de video como administrador, y luego vaya al Panel de Administrador.
- Haga clic en Integraciones, y luego elija API de LMS en la lista desplegable Seleccionar integración.
- Ingrese la siguiente información y luego haga clic en Guardar.
- Elija un LMS: Canvas
- Enlace URL a su LMS: https://<YOUR_CANVAS_DOMAIN> (consulte el paso 3 de la sección anterior para ver las zonas de dominio).
- ID de cliente: Ingrese el ID de cliente de Canvas de la sección anterior.
-
Secreto del cliente: Ingrese la clave de API de Canvas de la sección anterior.
-
Haga clic en Permitir el acceso a la API.
-
Con la sesión iniciada en Canvas como administrador, seleccione Autorizar para permitir que Lumina acceda a la API de Canvas.
Administración de las llamadas a la API de Canvas
Con la API de Canvas configurada, los administradores ahora podrán personalizar qué información se sincroniza de Canvas a Lumina. En general, recomendamos que las instituciones activen todas las opciones de configuración de sincronización para aprovechar esta funcionalidad.
-
Habilite las opciones que desee para que los administradores sincronicen información de Canvas a Lumina.
- Habilitar la sincronización de cursos de Canvas: Todos los cursos del Canvas de su organización se sincronizarán con la plataforma de video a diario.
- Habilitar la sincronización de usuarios de Canvas: Todos los usuarios del Canvas de su organización que estén inscritos en un curso de Canvas se sincronizarán con la plataforma de video a diario. Para los usuarios que tengan dos roles distintos en Canvas, la plataforma de video aprovisionará el rol superior.
- Habilitar la sincronización de inscripciones en Canvas: Todas las nuevas inscripciones de usuarios del Canvas de su organización se sincronizarán con la plataforma de video a diario.
- Habilitar la sincronización de grupos acomodados en Canvas: Todos los grupos acomodados de Canvas del Canvas de su organización se importarán a la plataforma de video a diario.
- Habilitar la sincronización de subcuentas de Canvas: Todas las subcuentas de Canvas asociadas con su organización se importarán a la plataforma de video a diario.
- Iniciar sincronizaciones: Sincronice de inmediato con la plataforma de video todas las opciones habilitadas anteriormente del Canvas de su organización.
- Haga clic en Guardar cambios para aplicar todos los cambios.
Configuración de la notificación de las llamadas a la API de Canvas
Los administradores pueden configurar un usuario para que reciba todas las notificaciones de las llamadas a la API de Canvas.
-
En la sección Notificaciones, ingrese el ID de usuario de YuJa por el que desea recibir las notificaciones.
- Haga clic en Guardar cambios para aplicar todos los cambios.
Configuración de la vinculación de la API de Canvas
Los administradores pueden establecer la Configuración de la vinculación para aprovisionar cursos y usuarios de Canvas a Lumina mediante la API de Canvas.
-
En Cursos de Canvas, marque la casilla Usar el código del curso y el período como campos de respaldo si no se encuentra un ID de curso de Canvas.
Nota: Para buscar solo los cursos de la plataforma de video aprovisionados mediante LTI, marque la casilla Ignorar los cursos YuJa que no cuentan con Interoperabilidad de Herramientas de Aprendizaje (LTI) al sincronizar los cursos Canvas.
- En Usuarios de Canvas, seleccione el Atributo principal de vinculación en el menú desplegable.
-
Marque la casilla Usar el correo electrónico y el nombre del usuario como campos de respaldo si no se encuentra un ID de usuario de Canvas .
Nota: Para buscar solo los usuarios de la plataforma de video aprovisionados mediante LTI, marque la casilla Ignorar los usuarios de YuJa que no son de Interoperabilidad de Herramientas de Aprendizaje (LTI) al sincronizar los usuarios de Canvas.
- Haga clic en Guardar cambios para aplicar todos los cambios.