¿Cómo creo una integración de datos automatizada para una cuenta con Canvas y mi SIS?

Las importaciones del sistema de información del estudiante (SIS) son una gran forma de importar de manera manual datos en lote (o cambios) en el sistema de Canvas. Esta lección proporcionará las lecciones básicas sobre cómo usar la API de Canvas y el lenguaje de programación de su elección para configurar un sistema automatizado para administrar su flujo de trabajo de importaciones de SIS.

Se pueden usar varios lenguajes de programación para construir una herramienta de integración automatizada con Canvas. Si su lenguaje de programación preferido puede hacer llamadas web (HTTPS) de capa de conexión segura (SSL) a un servidor externo y tiene la capacidad de publicar archivos, usted puede aplicar los pasos en esta lección al lenguaje de programación de su elección (o simplemente instale cURL y escribir un archivo de lote). Esta lección proporciona un abordaje simple para configurar un sistema básico de importación automatizada. No obstante, es posible que quiera desarrollar un sistema más complejo basado en sus aptitudes y en las habilidades de su integración de SIS específica.

Integraciones de datos de prueba

Para evitar afectar los datos en su entorno de producción, es posible que quiera configurar su integración de SIS en su entorno de prueba para una prueba segura. Cada tres semanas, el día después de la nueva versión de producción de Canvas, su entorno de producción creará una copia actualizada para su entorno de prueba para que usted pueda probar con los datos actualizados. Una vez que haya confirmado que sus datos funcionen correctamente, puede volver a aplicar su integración de SIS en el entorno de producción.

Alternativamente, puede crear sus cambios en su entorno de producción; después, espere la próxima actualización antes de comenzar a practicar en su entorno de prueba.

Ayuda avanzada

Abrir cuenta (Open Account)

Abrir cuenta (Open Account)

Haga clic en el enlace Administrador (Admin) [1], luego haga clic en el nombre de su cuenta [2].

Abrir Permisos

Abrir Permisos

En la Navegación de la cuenta, haga clic en el enlace Permisos (Permissions).

Modificar el rol y los permisos del usuario

En la pestaña Roles de la cuenta (Account Roles), cree un rol de usuario a nivel de la cuenta y permita al usuario administrar datos del SIS. Si no desea crear un nuevo rol de usuario, puede usar un rol de usuario existente y modificar los permisos.

Agregar nuevo usuario manualmente

Agregar nuevo usuario manualmente

Tendrá que agregar un nuevo usuario manualmente para administrar los datos de SIS. Puede usar un usuario existente importado a través de SIS, pero crear manualmente un nuevo usuario es conveniente por motivos de seguridad. Este nuevo usuario terminará con un permiso solamente, pero ese permiso le otorga la capacidad de crear, modificar y eliminar muchos tipos de objetos en Canvas.

Agregar usuario como administrador

Agregar usuario como administrador

Para habilitar los permisos de SIS, agregue su administrador como usuario administrativo para su cuenta. Configure el usuario con el rol del usuario en donde habilitó el permiso de datos de SIS.

Obtener autentificador de acceso a la API

Obtener autentificador de acceso a la API

Cierre sesión en Canvas y después vuelva a iniciar sesión como el usuario correcto. En Configuraciones del usuario (User Settings) en Integraciones aprobadas (Approved Integrations), agregue un nuevo autentificador de acceso. Deje la fecha de vencimiento en blanco a menos que tenga un motivo para especificar una fecha. Aprenda cómo obtener un autentificador de acceso a la API.

Nota: Asegúrese de guardar este autentificador de acceso a la API en un lugar seguro. Un autentificador de acceso a la API es efectivamente lo mismo que un nombre de usuario y contraseña, así que trátelo con seguridad similar. Recuerde que el autentificador creado en su entorno de prueba se reemplazará con el autentificador creado en su entorno de producción durante el próximo período de actualización del entorno de prueba.

Importar datos a través de la API

curl -H "Authorization: Bearer <api_token>" 'https://<canvas_fqdn>/api/v1/accounts/self/sis_imports/<import_id>'

Practique la importación de datos a través de la API. Un método de la API es usar cURL, una herramienta de línea de comando para transferir datos que se admite en todos los sistemas operativos (Windows, Linux y OSX). La API puede mostrarle cómo practicar la importación de un archivo de prueba y revisar el estado de una importación anterior.

Aprenda cómo usar la API para importar datos en Canvas.

Crear script de importación

Usando su lenguaje de programación preferido, cree un script de SIS. Un script de SIS sincroniza automáticamente los usuarios en su institución con su cuenta de Canvas. Vea el diagrama de flujo del script de SIS.

El script de programación puede ser tan simple o tan complejo como su institución lo requiera. Además, se puede usar una variedad de lenguajes de programación para escribir su script/programa de importación.

Aprenda más sobre cómo crear un script de SIS de Canvas.

Exportar datos y crear un archivo CSV de Canvas

Exporte sus datos de SIS en un formato de archivo CSV de Canvas. Coloque el archivo o los archivosen un directorio o carpeta que solamente contenga archivos CSV listos para importarse. Según su SIS, este paso puede estar automatizado. Para obtener más información sobre la integración, comuníquese con su Gerente de Satisfacción del Cliente de Canvas.

Exportaciones del SIS

Debido a las extensas variaciones entre los sistemas de información del estudiante (SIS), esta lección no puede documentar un método que incluya todo para la exportación de datos. Sin embargo, estos son algunos métodos posibles de acceso a los datos que pueden estar a su disposición:

  • Acceso a la API: El SIS puede proporcionar una API en alguna forma que le permitirá recopilar datos.
  • Datos directos (acceso a la base de datos): El SIS puede permitirle acceso directo a la base de datos (u otros datos directos)a sus datos de SIS.
  • Generación de reportes o exportación de datos: El SIS puede tener la habilidad de ejecutar reportes o exportar datos y hacer que se envíen por correo electrónico, desde un sitio web/programa o que se guarden en una carpeta.
  • Iniciador o registro de eventos: El SIS puede tener la habilidad de ejecutar trabajos en un evento iniciado. Este tipo de registro puede ser más apto para dirigir la manipulación de la API de objetos de Canvas, pero podría tener un script/programa que recopile los cambios iniciados para las actualizaciones en lote en intervalos frecuentes usando importaciones de SIS.

Una vez que sepa cómo acceder a sus datos de SIS, se puede escribir un script/programa y se lo puede usar para manipular y filtrar los datos para que coincidan con el formato requerido para las importaciones de SIS en CSV. En algunos casos, es posible que tenga que realizar este paso de manera manual. Tendrá que trabajar con el equipo administrativo de su SIS o proveedor para elaborar la mejor forma de exportar los datos.

Nota: Al trabajar con el equipo de su SIS, asegúrese de proporcionarles la documentación en formato de archivo CSV de Canvas, que puede reducir la complejidad o eliminar la necesidad de un script/programa para preparar los datos antes de la importación.