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

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}

Списки

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 для образования, связанных с заданиями.

Классная работа

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

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

• educationModule — модуль связан с классом. Представляет группу отдельных учебных ресурсов, которые организованы систематически.
• educationModuleResource — объект-оболочка, в котором хранятся ресурсы, связанные с модулем. Учащийся не может обновить этот ресурс, который представляет собой раздаточные материалы от преподавателя к учащемуся, в котором ничего не должно быть сдано.

В следующих списках показаны сценарии, поддерживаемые API Classwork.

Модули

Ресурс educationModule поддерживает следующие сценарии:

• Вывод списка модулей
• Создание модуля
• Получение модуля
• Обновление модуля
• Удалить модуль
• Закрепление модуля
• Открепить модуль
• Модуль публикации
• Настройка папки ресурсов модуля

Ресурсы модуля

Ресурс educationModuleResource поддерживает следующие сценарии:

• Вывод списка ресурсов модуля
• Создание ресурса модуля
• Получение ресурса модуля
• Обновление ресурса модуля
• Удаление ресурса из модуля

Основные варианты использования

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

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

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

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

• Вывод списка профилей синхронизации
• Получение профиля синхронизации
• Создание профиля синхронизации
• Удаление профиля синхронизации
• Приостановка текущей синхронизации
• Возобновление приостановленной синхронизации
• Сброс синхронизации
• Запуск синхронизации для отправленных файлов
• Получение URL-адреса отправки
• Получение состояния синхронизации
• Получение ошибок синхронизации

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

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

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