Работа с интерфейсами 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}
| Параметр | Описание |
|---|---|
| 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 для образования, связанных с заданиями.
| Вариант использования | Описание | См. также |
|---|---|---|
| Создание заданий | Внешняя система может создать задание для класса и вложить ресурсы для задания. | Создание задания |
| Чтение сведений о задании | Приложение аналитики может получать сведения о заданиях и сданных работах учащихся, включая даты и оценки. | Получение задания |
| Отслеживание сданных работ учащихся | Ваше приложение может предоставлять информационную панель для преподавателей, указывающую количество сданных работ учащихся, которые нужно оценить. | Ресурс сданной работы |
Дальнейшие действия
С помощью API для образования в Microsoft Graph вы можете создавать решения с доступом к спискам пользователей учебного заведения. Чтобы узнать больше:
- Изучите ресурсы и методы, наиболее полезные для вашего сценария.
- опробуйте API в песочнице Graph.