在 Microsoft Graph 中使用教育 API

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

Microsoft Graph 中的教育 Api 使用与教育方案相关的信息(包括学校、学生、教师、课程、注册和工作分配)来增强 Microsoft 365 的资源和数据。 这使你能够轻松地构建与教育资源集成的解决方案。

教育 Api 包括名册资源和工作分配资源,您可以使用这些资源与 Microsoft 团队中的名册和工作分配服务进行交互。 您可以使用这些资源管理学校名单并自动完成学生作业。

授权

若要在 Microsoft Graph 中调用教育 API,你的应用需要获取访问令牌。 有关访问令牌的详细信息,请参阅获取用于调用 Microsoft Graph 的访问令牌。 你的应用还需要具有相应的权限。 有关详细信息,请参阅教育权限

若要部署与 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 提供以下关键资源:

名册 API 支持以下方案:

作业

您可以使用与工作分配相关的教育 Api 与 Microsoft 团队中的工作分配集成。 Microsoft 365 for 教育版的 microsoft 团队基于相同的教育 Api,并为使用 Api 时可以执行的操作提供了一个用例。 您的应用程序可以使用这些 Api 与工作分配生命周期中的工作分配进行交互。

分配 Api 提供以下关键资源:

  • educationAssignment -工作分配 API 的核心对象。 表示分配给课程中的学生或团队成员的任务或工作单元,作为其研究的一部分。
  • educationSubmission -表示单个 (或组) 为工作分配提交的资源,以及该工作分配的相关评分和反馈。
  • educationResource -表示要分配或提交的学习对象。 EducationResourceeducationAssignment和/或educationSubmission相关联。

分配 Api 支持以下方案:

以下是与工作分配相关的教育 Api 的一些常见用例。

用例 说明 另请参阅
创建工作分配 外部系统可以为类创建分配并将资源附加到工作分配。 创建作业
读取工作分配信息 分析应用程序可以获取有关工作分配和学生提交的信息,包括日期和成绩。 获取作业
跟踪学生提交 您的应用程序可以提供一个教师仪表板,以显示学生的提交次数需要进行评分。 提交资源

学校数据同步管理

学校数据同步 可帮助您自动执行从学生信息系统中导入和同步名单数据的过程,该过程与 Azure Active Directory (azure AD) 和 Microsoft 365。 您可以使用 Microsoft Graph 中的学校数据同步管理 Api 设置 CSV 文件或受支持的 SIS API 连接器的同步。

学校数据同步管理 Api 支持以下方案:

最近更新

了解此 API 集的最新功能和更新

后续步骤

使用 Microsoft Graph 教育 Api 生成可访问学生工作分配和学校名册的教育解决方案。 了解详细信息:

  • 探索对你的方案最有帮助的资源和方法。
  • 尝试在 Graph 浏览器中使用 API。