在 Microsoft Graph 中使用教育 API
Microsoft Graph 中的教育 API 可增强 Microsoft 365 资源和与教育情景(包括学校、学生、教师、课程和注册)相关的信息的数据。 这使你能够轻松地构建与教育资源集成的解决方案。
教育 API 包含名册资源和作业资源,可以使用这些资源与 Microsoft Teams 中的名册服务进行交互。 可以使用这些资源来管理学校名册。
授权
若要在 Microsoft Graph 中调用教育 API,你的应用需要获取访问令牌。 有关访问令牌的详细信息,请参阅获取用于调用 Microsoft Graph 的访问令牌。 你的应用还需要具有相应的权限。 有关详细信息,请参阅教育权限。
请求学校 IT 管理员许可的应用权限
若要部署与 Microsoft Graph 中的教育 API 集成的应用,学校 IT 管理员必须首先授权许可应用请求的权限。 仅能授权许可一次,除非权限更改。 在管理员许可后,就会为租户中的所有用户预配应用。
若要显示许可对话框,请执行以下 REST 调用。
GET https://login.microsoftonline.com/{tenant}/adminconsent?
client_id={clientId}&state=12345&redirect_uri={redirectUrl}
参数 | 说明 |
---|---|
Tenant | 学校的租户 ID。 使用完整 ID,其中包含 onmicrosoft.com。 |
clientId | 应用的客户端 ID。 |
redirectUrl | 应用重定向 URL。 |
Rostering
借助名册 API,可以从学校的 Microsoft 365 租户(预配了 Microsoft 学校数据同步)中提取数据。这些 API 提供对有关学校、部门、教师、学生和名册的信息的访问权限。 API 既支持仅应用(同步)方案,也支持应用 + 用户(交互)方案。 支持交互式方案的 API 基于调用 API 的用户角色,强制实施相应地区的 RBAC 策略。 这可以提供一致的 API 和最小策略展现,而无需考虑租户中的管理配置。 此外,API 还提供特定于教育的权限,确保相应用户具有访问数据的权限。
可以使用名册 API 让应用用户了解:
- 我是谁
- 我参加或教学的课程
- 我需要做什么以及完成时间
名册 API 提供以下关键资源:
- educationSchool - 表示学校。
- educationClass - 表示学校的课程。
- educationTerm - 表示学年的指定部分。
- educationTeacher - 表示主要角色为“教师”的用户。
- educationStudent - 表示主要角色为“学生”的用户。
名册 API 支持以下方案:
作业
可以使用与作业相关的教育 API 与 Microsoft Teams 中的作业集成。 Microsoft 365 教育版中的 Microsoft Teams 基于同一教育 API,并提供了使用 API 执行哪些操作的用例。 应用可以使用这些 API 在整个作业生命周期内与作业进行交互。
作业 API 提供以下关键资源:
- educationAssignment - 作业 API 的核心对象。 是指将任务或工作单元分配给课程中的学生或团队成员,作为其学习的一部分。
- educationSubmission - 是指个人(或组)提交作业的资源以及该作业的相关成绩和反馈。
- educationResource - 是指正在分配或提交的学习对象。 educationResource与 educationAssignment和/或 educationSubmission 相关联。
作业 API 支持以下方案:
以下是与作业相关的教育 API 的一些常见用例。
用例 | 说明 | 另请参阅 |
---|---|---|
创建作业 | 外部系统可以创建课堂作业并将资源附加到作业。 | 创建作业 |
阅读作业信息 | 分析应用可以获取有关作业和学生提交(包括日期和成绩)的信息。 | 获取作业 |
跟踪学生作业提交 | 应用可为教师提供仪表板,显示有多少学生提交的作业需要评分。 | 提交资源 |
后续步骤
使用 Microsoft Graph 教育 API 构建访问学校名册的教育解决方案。 了解详细信息:
- 探索对你的方案最有帮助的资源和方法。
- 尝试在 Graph 浏览器中使用 API。