Trabajar con API para el ámbito educativo en Microsoft Graph

Las API de educación de Microsoft Graph mejoran los recursos y los datos de Microsoft 365 con información que es relevante para escenarios educativos, incluidas las escuelas, los alumnos, los profesores, las clases, las inscripciones y las asignaciones. Esto hace que resulte fácil compilar soluciones que se integran con recursos educativos.

Las API de educación incluyen recursos de listas y asignaciones que puede usar para interactuar con los servicios de listas y asignaciones en Microsoft Teams. Puede usar estos recursos para administrar una lista educativa y automatizar las asignaciones de alumnos.

Autorización

Para llamar a las API de educación en Microsoft Graph, la aplicación debe adquirir un token de acceso. Para obtener más información sobre los tokens de acceso, vea Obtener tokens de acceso para llamar a Microsoft Graph. La aplicación también necesita los permisos adecuados. Para obtener más información, vea Permisos para el ámbito educativo.

Permisos de aplicación para habilitar a los administradores de TI del centro educativo para dar consentimiento

Para implementar aplicaciones que se integran con las API para el ámbito educativo de Microsoft Graph, los administradores de TI del centro educativo deben dar primero consentimiento a los permisos que solicita la aplicación. Este consentimiento únicamente hay que darlo una sola vez, a menos que cambien los permisos. Cuando el administrador da el consentimiento, la aplicación se aprovisiona para todos los usuarios del inquilino.

Para desencadenar un cuadro de diálogo de consentimiento, use la siguiente llamada REST.

GET https://login.microsoftonline.com/{tenant}/adminconsent?
client_id={clientId}&state=12345&redirect_uri={redirectUrl}

Generación de listados

Las API de generación de listados permiten extraer datos de una cuenta empresarial de Microsoft 365 del centro educativo aprovisionado con Microsoft School Data Sync. Estas API ofrecen acceso a información sobre los centros educativos, las secciones, los profesores, los alumnos y los listados. La API admiten tanto escenarios solo de aplicación (sincronización) como escenarios de aplicación y usuario (interactivos). Las API que admiten escenarios interactivos aplican directivas de RBAC adecuadas a la región según el rol de usuario que llama a la API. Esto proporciona una API coherente y una superficie de directiva mínima, independientemente de la configuración de administración de inquilinos. Además, las API proporcionan también permisos específicos del ámbito educativo para asegurarse de que el usuario correcto tiene acceso a los datos.

Puede usar las API de generación de listados para permitir que un usuario de la aplicación conozca:

• Quién soy
• Clases a las que asisto o que imparto
• Lo que tengo que hacer y cuándo

Las API de generación de listados ofrecen los siguientes recursos claves:

• educationSchool: representa el centro educativo.
• educationClass: representa una clase en un centro educativo.
• educationTerm: representa una parte designada del año académico.
• educationTeacher: Representa a un usuario con el rol principal de "Profesor".
• educationStudent: Representa a un usuario con el rol principal de "alumno".

Las API de generación de listados admiten los siguientes escenarios:

• Mostrar todos los centros educativos
• Mostrar los centros educativos en los que se imparte una clase
• Mostrar los centros educativos correspondientes a un usuario
• Obtener todas las clases
• Obtener las clases de un centro educativo
• Mostrar las clases correspondientes a un usuario
• Agregar clases a un centro educativo
• Obtener los alumnos y profesores de una clase
• Agregar miembros a una clase
• Mostrar los profesores de una clase
• Obtener los usuarios de un centro educativo

Tareas

Puede usar las API para el ámbito educativo relacionadas con la tarea para integrarlas con tareas en Microsoft Teams. Microsoft Teams en Microsoft 365 for Education se basa en las mismas API para el ámbito educativo y le proporciona un caso de uso sobre lo que puede hacer con las API. La aplicación puede usar estas API para interactuar con las tareas durante el ciclo de vida de la tarea.

Las API de tarea proporcionan los siguientes recursos clave:

• educationAssignment: el objeto principal de la API de tareas. Representa una tarea o unidad de trabajo asignada a un alumno o miembro del equipo en una clase como parte del estudio.
• educationSubmission: representa los recursos que una persona (o grupo) envía para una tarea, así como la calificación y los comentarios asociados a esa tarea.
• educationResource: representa el objeto de aprendizaje que se va a asignar o enviar. Un educationResource está asociado con una educationAssignment y/o un educationSubmission.

Las API de tarea admiten los siguientes escenarios:

• Crear una tarea
• Publicar la tarea
• Crear recursos de la tarea
• Crear recursos de envío
• Enviar la tarea
• Cancelar el envío de la tarea
• Entregar calificaciones y comentarios al alumno
• Obtener detalles de la tarea

A continuación, se muestran algunos casos de uso comunes de las API para el ámbito educativo relacionadas con la asignación.

Classwork

Puede usar Classwork como tienda integral para crear y organizar recursos de clase, incluidas las asignaciones, las páginas del bloc de notas de clase de OneNote, los vínculos web, los archivos y los canales de Teams. Esto significa que ya no tiene que navegar por varias aplicaciones y plataformas para encontrar lo que necesita. Con Classwork, puede seleccionar una vista del contenido y los recursos que ayude a los alumnos a navegar por la clase y ver todo en un solo lugar.

Classwork API proporciona los siguientes recursos clave:

• educationModule : un módulo está asociado a una clase. Representa un grupo de recursos de aprendizaje individuales organizados de forma sistemática.
• educationModuleResource : objeto contenedor que almacena los recursos asociados a un módulo. El alumno no puede actualizar este recurso, que es un documento del profesor al alumno sin que se le entregue nada.

En las listas siguientes se muestran los escenarios admitidos por classwork API.

Módulos

El recurso educationModule admite los siguientes escenarios:

• Enumerar módulos
• Creación de un módulo
• Obtener módulo
• Actualizar módulo
• Eliminar módulo
• Anclar módulo
• Desanclar módulo
• Módulo de publicación
• Configurar la carpeta de recursos del módulo

Recursos del módulo

El recurso educationModuleResource admite los siguientes escenarios:

• Enumerar recursos de módulo
• Creación de un recurso de módulo
• Obtención del recurso del módulo
• Actualizar recurso de módulo
• Eliminación de recursos del módulo

Casos de uso comunes

En la tabla siguiente se muestran algunos casos de uso comunes para las API de educación relacionadas con módulos.

Administración de sincronización de datos educativos

School Data Sync ayuda a automatizar el proceso de importación y sincronización de datos de lista de los sistemas de información de alumnos con Microsoft Entra ID y Microsoft 365. Puede usar las API de administración de sincronización de datos de la escuela en Microsoft Graph para configurar la sincronización desde un archivo CSV o un conector de API de SIS compatible.

Las API de administración de sincronización de datos de la escuela admiten los siguientes escenarios:

• Enumerar perfiles de sincronización
• Obtención del perfil de sincronización
• Creación de un perfil de sincronización
• Eliminar perfil de sincronización
• Pausar una sincronización en curso
• Reanudación de una sincronización en pausa
• Restablecer una sincronización
• Inicio de la sincronización de archivos cargados
• Obtención de una dirección URL de carga
• Obtener el estado de una sincronización
• Obtención de errores de sincronización

Siguientes pasos

Use las API de educación de Microsoft Graph para crear soluciones educativas que accedan a asignaciones de alumnos y listas educativas. Para obtener más información:

• Explore los recursos y los métodos que son más útiles para su escenario.
• Pruebe la API en el Probador de Graph.