Trabajar con API para el ámbito educativo en Microsoft Graph

  • Artículo

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

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 para el ámbito educativo de Microsoft Graph, la aplicación tiene que 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 necesitará los permisos adecuados. Para obtener más información, vea Permisos para el ámbito educativo.

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}
Parámetro Descripción
Tenant Identificador de inquilino del centro educativo. Use el identificador completo, que incluye onmicrosoft.com.
clientId Identificador de cliente de la aplicación.
redirectUrl Dirección URL de redireccionamiento de la aplicación

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:

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

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:

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

Caso de uso Descripción Ver también
Crear tareas Un sistema externo puede crear una tarea para la clase y adjuntar recursos a la tarea. Crear una tarea
Leer la información de la tarea Una aplicación de análisis puede obtener información sobre tareas y envíos de alumnos, incluidas las fechas y las calificaciones. Obtener la tarea
Realizar un seguimiento de los envíos de alumnos La aplicación puede proporcionar un panel de control del profesor que muestre cuántos envíos de los alumnos deben calificarse. Recurso de envío

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 los 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:

Pasos siguientes

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.