Работа с интерфейсами API для образования в Microsoft Graph

  • Статья

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

API-интерфейсы для образовательных учреждений в Microsoft Graph расширяют ресурсы и данные Microsoft 365, используя информацию, относяющуюся к сценариям образования, включая школы, учащихся, преподавателей, классы, учебные заведения и задания. Это упрощает создание решений, интегрируемых с образовательными ресурсами.

API для образовательных учреждений включают ресурсы реестра и ресурсы назначений, которые можно использовать для взаимодействия со службами реестров и назначений в Microsoft Teams. Эти ресурсы можно использовать для управления списком учащихся и автоматизации заданий учащихся.

Авторизация

Чтобы вызывать API для образования в Microsoft Graph, приложению необходимо получить маркер доступа. Подробные сведения о маркерах доступа см. в статье Получение маркеров доступа для вызова Microsoft Graph. Приложению также потребуются соответствующие разрешения. Дополнительные сведения см. в разделе Разрешения для образования.

Для развертывания приложений, интегрированных с API для образования в Microsoft Graph, ИТ-администраторы учебного заведения должны предоставить разрешения, запрашиваемые приложением. Повторный запрос появится, только если разрешения изменятся. Когда администратор предоставит разрешения, приложение будет подготовлено к работе для всех пользователей в клиенте.

Чтобы активировать диалоговое окно согласия, используйте следующий вызов REST.

GET https://login.microsoftonline.com/{tenant}/adminconsent?
client_id={clientId}&state=12345&redirect_uri={redirectUrl}
Параметр Описание
Tenant ИД клиента учебного заведения. Используйте полный идентификатор, например onmicrosoft.com.
clientId Идентификатор клиента приложения.
redirectUrl URL-адрес перенаправления приложения.

Списки

API для работы со списком позволяют извлекать данные из клиента Microsoft 365 учебного заведения, подготовленного с помощью Microsoft School Data Sync. Эти API предоставляют доступ к сведениям об учебных заведениях, секциях, преподавателях, учащихся и списках. Эти API поддерживают как сценарии только для приложений (синхронизацию), так и сценарии для приложений и пользователей (интерактивные). API, поддерживающие интерактивные сценарии, применяют политики RBAC на основе роли вызывающего API пользователя. Это обеспечивает согласованность API и минимальную область действия политики независимо от конфигурации администрирования в клиентах. Кроме того, API также предоставляют разрешения для образования, позволяющие настроить доступ к данным.

С помощью API для работы со списком можно предоставить пользователю приложения следующие сведения:

  • его роль;
  • предметы, которые он изучает или преподает;
  • задания и сроки их выполнения.

API для работы со списком предоставляют следующие ключевые ресурсы:

  • educationSchool — учебное заведение;
  • educationClass — класс в учебном заведении;
  • educationTerm — определенная часть учебного года;
  • educationTeacher — пользователи с основной ролью "Преподаватель";
  • educationStudent — представляет пользователей с основной ролью "Учащийся".

API для работы со списком поддерживают следующие сценарии:

Задания

Вы можете использовать API для образования, связанные с заданиями, чтобы выполнять интеграцию с заданиями в Microsoft Teams. Microsoft Teams в Microsoft 365 для образования основан на тех же API для образования и предоставляет вариант использования API. Ваше приложение может использовать эти API для взаимодействия с заданиями в течение всего жизненного цикла задания.

API заданий предоставляют следующие ключевые ресурсы.

  • educationAssignment — основной объект API заданий. Представляет задачу или единицу работы, назначенную учащемуся или участнику команды в классе в рамках его исследования.
  • educationSubmission — представляет ресурсы, отправляемые человеком (или группой) в рамках задания, а также связанные оценки и отзывы по этому заданию.
  • educationResource — представляет объект обучения, который назначается или отправляется. Объект educationResource связан с educationAssignment и/или educationSubmission.

API заданий поддерживают следующие сценарии.

Ниже приводится несколько распространенных вариантов использования API для образования, связанных с заданиями.

Вариант использования Описание См. также
Создание заданий Внешняя система может создать задание для класса и вложить ресурсы для задания. Создание задания
Чтение сведений о задании Приложение аналитики может получать сведения о заданиях и сданных работах учащихся, включая даты и оценки. Получение задания
Отслеживание сданных работ учащихся Ваше приложение может предоставлять информационную панель для преподавателей, указывающую количество сданных работ учащихся, которые нужно оценить. Ресурс сданной работы

Управление синхронизацией данных в учебном заведении

School Data Sync помогает автоматизировать процесс импорта и синхронизации данных реестра из информационных систем учащихся с помощью Microsoft Entra ID и Microsoft 365. Вы можете использовать API-интерфейсы управления синхронизацией данных в Microsoft Graph для настройки синхронизации из CSV-файла или поддерживаемого соединителя API SIS.

API-интерфейсы управления синхронизацией данных в учебном заведении поддерживают следующие сценарии:

Дальнейшие действия

Используйте API Microsoft Graph для образования для создания решений для образования, которые получают доступ к заданиям учащихся и спискам учащихся. Чтобы узнать больше:

  • Изучите ресурсы и методы, наиболее полезные для вашего сценария.
  • опробуйте API в песочнице Graph.