OneRoster API (应用程序编程接口) 是一种行业Standard格式，来自 1EdTech (以前的 IMS Global) ，用于交换学生信息系统 (SIS) /学生管理系统 (短信) 数据。 使用此同步方法，可以使用 SIS/SMS 提供程序开发的基于 REST 的 OneRoster 1.1 API 直接连接到 SIS/SMS。 API 支持允许直接同步数据，而不是使用 CSV (逗号分隔值) 文件。
使用 OneRoster API 引入数据使你能够打开用于预配的核心 SDS 功能。 它还允许你增强 Microsoft 365 产品和功能的体验。 OneRoster API 是我们如何从通过学校数据同步 (SDS) 平台提供 OneRoster API 的 SIS/短信同步对象。
有关如何设置租户以使用 OneRoster API 作为源的详细信息，请参阅 使用 OneRoster API 引入数据。
OneRoster 提供程序状态和功能
我的提供商未在下拉列表中列出，并且此处的状态显示“ 测试”。 我需要执行哪些操作才能在提供商列表中看到它们？
请联系 客户支持团队 ，对租户进行外部测试，并获取对当前 测试的 API 提供程序的访问权限。 提出请求时共享以下信息：
- 租户 ID
- OneRoster 提供程序名称
- SDS 版本
- 名单
对租户进行外部测试后，请使用 OneRoster 提供程序和 SDS POC 运行测试并确保集成成功。 如果遇到任何问题，请与提供商和 SDS POC 合作解决它们。
测试成功后，OneRoster 提供程序状态将 (从测试模式更新为“是”) ，并在所有租户的可公开访问的提供程序列表中提供。
我的提供商未列出。 是否有信息可以与他们共享以作为 OneRoster 提供商参与 SDS？
引入名单数据时访问了哪些终结点？
- 以下列表有助于更好地了解通过 OneRoster API 连接到 SIS/SMS 时访问的数据。
SDS 所需的 API 终结点
| 操作 |
URL |
必需的筛选器属性 |
可选/推荐筛选器 |
示例 |
| GetAllAcademicSessions |
/academicSessions |
status |
dateLastModified |
/academicSessions？offset=0&limit=5000&filter=status='active'/academicSessions？filter=dateLastModified>'{deltaDateTime}' |
| GetAllOrgs |
/orgs |
status |
dateLastModified |
/orgs？offset=0&limit=5000&filter=status='active'/orgs？filter=dateLastModified>'{deltaDateTime}' |
| GetAllUsers |
/users |
status |
dateLastModified |
/users？offset=0&limit=5000&filter=status='active'/users？filter=dateLastModified>'{deltaDateTime}' |
| GetAllClasses |
/classes |
status |
dateLastModified |
/classes？offset=0&limit=5000&filter=status='active'/classes？filter=dateLastModified>'{deltaDateTime}' |
| GetAllEnrollments |
/enrollments |
status |
dateLastModified |
/enrollments？offset=0&limit=5000&filter=status='active'/enrollments？filter=dateLastModified>'{deltaDateTime}' |
SDS 的可选 API 终结点
注意
对于统计数据、学生联系关系和学生用户标志的可选数据片段，是否包含这些数据取决于 SIS/SMS OneRoster 提供程序配置文件中支持的可选数据功能。 如果 SIS/SMS 提供程序也支持此数据，则可以看到 (默认) 选择“ 打开 ”以包含其他数据的开关。 如果需要，可以选择关闭的开关。 如果开关不可用、显示但已关闭且不可交互，则意味着提供商配置文件当前不支持提供该数据。
注意
如果提供商的配置文件将人口统计信息、联系人或用户统计标志显示为不可用，并且你希望他们支持该功能，请联系你的提供商并请求添加支持，以使 SDS 能够引入数据，并允许你启用数据支持的方案和体验。
| 操作 |
URL |
必需的筛选器属性 |
可选/推荐筛选器 |
示例 |
| GetAllCourses |
/courses |
status |
dateLastModified |
/courses？offset=0&limit=5000&filter=status='active'/courses？filter=dateLastModified>'{deltaDateTime}' |
| GetAllDemographics |
/demographics |
status |
dateLastModified |
/demographics？offset=0&limit=5000&filter=status='active'/demographics？filter=dateLastModified>'{deltaDateTime}' |
可选用户学生联系关系
可以为学生用户指定学生联系关系，以增强教师与家长和监护人的通信体验。 联系人是提供给 /users 的更多用户，并且与学生的关联可以在“代理”下的学生用户记录中找到。
有关详细信息，请参阅 SDS 支持的支持的学生联系关系角色， 请参阅默认值列表：联系关系角色。
具有联系人/监护人角色的用户需要 familyName、givenName 和电子邮件。
预计电话和短信采用 E.164 格式，并且必须包含 +。 (示例：+1234567890)
如果在联系人用户“代理”字段中提供了从联系人关系监护人记录到学生的反向数据，则这些记录将被筛选掉。
可选用户人口统计信息标志
可以为学生用户指定用户标志，以指示他们参与计划或队列。 当用户) 为 true 时， (包括用户标志，如果不适用，则不包括在内。
标志指定为用户的元数据扩展，在元数据字段中，在 Key|值对。 该键应命名为 microsoft.userFlags，并且必须格式化为逗号分隔的列表。 用户标志可以按任意顺序显示，并且不区分大小写。
有关详细信息，请参阅 SDS 支持的用户标志值的默认列表， 请参阅默认值列表：用户标志。
示例：
{
"user" : {
…
…
"metadata" : {
"microsoft.userFlags" : "freeLunch,homeless,giftedOrTalented“
}
}
重要
根据 1EdTech，提供商有责任在提出数据请求时对可用数据实施数据隐私。 学校数据同步 根据请求的时间发出活动数据请求。
OneRoster API 访问需要凭据
若要为 SIS/SMS 启用与 OneRoster API 的连接，需要提供连接凭据。 有关更多信息，请参阅特定提供商的文档以获取或生成它们。
Web 访问 URL：SIS/SMS 可访问 OneRoster API 的 URL
用于连接到 SIS/SMS OneRoster API 的客户端 ID
用于连接到 SIS/SMS OneRoster API 的客户端密码
访问令牌 URL，如果 SIS/SMS OneRoster API 配置为使用 OAuth2 进行身份验证，则需要提供用于连接的访问令牌 URL 终结点。 终结点不同于 Web 访问 URL。
有用的笔记和提示
- 终结点始终位于“https://{server_URL}/ims/oneroster/v1p1”之后
- 为了防止某些学校包含在从 SIS 提供给 SDS 的数据中，客户需要与其提供商合作，了解如何配置用于将 SDS 链接到其 SIS 的连接/凭据包含哪些学校。
- 终结点对筛选器参数支持有要求，以允许按状态筛选或启用增量同步。
- SDS 对增量同步/增量同步处理的 dateLastModified 属性应用筛选器，并且是与 SDS 集成所必需的。
- 提供程序必须选择实现 OAuth1 () 或 OAuth 2.0 (客户端凭据授予) 身份验证方案。 首选 OAuth 2.0。
- 如果支持的身份验证协议是“OAuth 2.0”–客户端凭据授予类型，SDS 将在“授权”标头中发送凭据。 按照 OneRoster 规范中的建议，我们在令牌请求的授权标头中发送编码的客户端凭据。
OneRoster 提供程序详细信息
Aequitas
| SIS 供应商 |
Aequitas Solutions， Inc |
|
软件的最低版本 |
Q 3.6.1、Q Web API 3.6.0 |
|
配置先决条件 |
查看 Q Web API 设置 |
|
如何获取客户端 ID、客户端密码和 URL () |
查看 Q Web API 设置 |
|
具体说明 |
不适用 |
|
Help |
请致电 (909) 946-1600 联系支持人员 |
Aeries
AI 数据
| SIS 供应商 |
DataEum |
|
软件的最低版本 |
不适用 |
|
配置先决条件 |
无 |
|
如何获取客户端 ID、客户端密码和 URL () |
Email 客户支持以请求 OneRoster API 凭据。 |
|
具体说明 |
联系客户支持 pbd@i-data.ai |
|
Help |
联系客户支持 pbd@i-data.ai |
Arbor Education
Blackbaud 教育管理
| SIS 供应商 |
Blackbaud 教育管理 |
|
软件的最低版本 |
BEM 的最新版本始终可供用户使用。 |
|
配置先决条件 |
不适用 |
|
如何获取客户端 ID、客户端密码和 URL () |
这里介绍了分步说明 |
|
具体说明 |
为 Microsoft Entra 用户选择映射设置时，请确保包含/排除域后缀的设置与 Microsoft Entra 用户名匹配。 此操作可确保在将 BEM 学生和教师与 Microsoft Entra 用户匹配时获得最佳结果。 |
|
Help |
support.blackbaud.com |
Bubblecon
| SIS 供应商 |
Bubblecon |
|
具体说明 |
联系 Bubblecon 客户支持团队。 |
ClassLink
| SIS 供应商 |
ClassLink |
|
软件的最低版本 |
不适用 |
|
配置先决条件 |
在控制台中添加 SDS 应用。 选择添加 应用程序 & 修改权限 获取说明。 |
|
如何获取客户端 ID、客户端密码和 URL () |
客户可在添加应用后从主机获取其 oAuth 凭据。 会向设置应用的 Microsoft 开发人员发送电子邮件。 选择“ 添加应用程序”&“修改权限 ”以显示获取客户端 ID 和密码的位置。 |
|
如果连接时出现问题，请确保 Web 访问 URL 具有“/ims/oneroster/v1p1”以指向正确的连接器。 |
|
具体说明 |
不适用 |
|
Help |
E-mail rostersupport@classlink.com. |
Classter
Edge Learning
社区品牌教育
Edulife Connect
| SIS 供应商 |
Edulife Connect |
|
软件的最低版本 |
不适用 |
|
配置先决条件 |
不适用 |
|
如何获取客户端 ID、客户端密码和 URL () |
直接与我们的部署和支持团队联系完成。 |
|
具体说明 |
不适用 |
|
Help |
请联系支持人员，请访问 support@wizkids.co.uk。 // 020 7550 9286 |
eSchoolData
| SIS 供应商 |
eSchoolData |
|
软件的最低版本 |
不适用 |
|
配置先决条件 |
地区必须是 eSD GURU 产品的订阅者。 |
|
如何获取客户端 ID、客户端密码和 URL () |
请参阅具体说明。 |
|
具体说明 |
为了启用与 SDS 的 API 集成，地区管理员必须首先在 GURU 内创建一个供应商帐户。 导航到“配置 > 供应商”，然后选择“创建新供应商”。 输入供应商名称并保留自动生成的客户端 ID 和客户端密码。 配置 SDS 集成时，提供区域 GURU API URL。 选择“下一步”并启用所有 OneRoster API 权限。 完成后选择“完成”以保存新帐户。 |
|
Help |
如有疑问，请联系您的 eSchoolData 支持团队。 |
eSchooling
| SIS 供应商 |
Codevision 的电子教育 |
|
软件的最低版本 |
1.1.20 |
|
配置先决条件 |
无 |
|
如何获取客户端 ID、客户端密码和 URL () |
按照电子教育平台的说明进行操作： 系统管理 > 学校数据同步 |
|
具体说明 |
与之前相同 |
|
Help |
联系我们 suporte@codevision.pt |
Eventful
事实
| SIS 供应商 |
事实 |
|
软件的最低版本 |
不适用。 客户始终可以使用最新版本。 |
|
配置先决条件 |
不适用 |
|
如何获取客户端 ID、客户端密码和 URL () |
客户注册 OneRoster API，FACTS 向其提供此信息。 |
|
具体说明 |
在 SIS 中，转到“系统 > 配置 > ” SIS 集成 > OneRoster API > 填写表单。 |
|
Help |
客户支持 866-800-6593 |
Focus School 软件
| SIS 供应商 |
Focus School 软件 |
|
软件的最低版本 |
Focus v 8.7 |
|
配置先决条件 |
不适用 |
|
如何获取客户端 ID、客户端密码和 URL () |
在 Focus 门户屏幕中，设置 > 系统设置第三方 > 系统。 在记录插入行上，输入“标题：Microsoft 版本 1.0 > 方言：OneRoster。 保存后，将生成 URL、客户端 ID 和客户端密码。 |
|
具体说明 |
不适用 |
|
Help |
拨打 Focus 的电话支持热线 877-410-6637。 |
Follett Aspen
| SIS 供应商 |
Follett Aspen |
|
软件的最低版本 |
Aspen 最新版本，5.9 |
|
配置先决条件 |
不适用 |
|
如何获取客户端 ID、客户端密码和 URL () |
请联系您所在地区的客户关系经理以安排升级。 |
|
具体说明 |
不适用 |
|
Help |
请联系客户关系经理寻求帮助。 |
弗隆学校基地
| SIS 供应商 |
弗隆学校基地 |
|
软件的最低版本 |
仅使用最新版本的托管学校 |
|
配置先决条件 |
不适用 |
|
如何获取客户端 ID、客户端密码和 URL () |
可在 此处找到相关说明。 |
|
具体说明 |
不适用 |
|
Help |
使用 Furlong 开票。 |
INACAP SDS API
Infinitas 学习
| SIS 供应商 |
Informat |
|
软件的最低版本 |
不适用 |
|
配置先决条件 |
不适用 |
|
如何获取客户端 ID、客户端密码和 URL () |
完成接收表格后，将提供客户端 ID 和客户端密码 |
|
具体说明 |
此处提供了详细说明 |
|
Help |
联系 Inform 支持人员 |
Infinite Campus
| SIS 供应商 |
Infinite Campus |
|
软件的最低版本 |
对于花名册预配，最低版本是 Campus.1821。 |
|
配置先决条件 |
创建 OAuth 客户端 |
|
如何获取客户端 ID、客户端密码和 URL () |
登录并查找有关 oAuth 配置屏幕的最新产品文档，请参阅 Infinite Campus 的 OneRoster 指南 |
|
具体说明 |
在 V 1933.3 之前 - 转到 Infinite Campus 用户界面 >> ，选择“系统管理 >> ”，选择“校园学习 >> ”，选择“OneRoster 工具” >> ，在 OneRoster 上选择。 版本 1933.3 及更高版本 - 转到 Infinite Campus 用户界面 >> ，选择“系统管理 >> ”，选择“学习互操作性”。 |
|
在无限校园中选择要同步的属性时，请确保 未 选择句点。 如果选择它，则同步时可能会生成大量错误，并将配置文件锁定在隔离区中。 |
|
Help |
如需帮助，请联系客户成功经理。 |
inLogic
IRIS 的 iSAMS
IST
| SIS 供应商 |
IST |
|
软件的最低版本 |
不适用。 |
|
配置先决条件 |
请参阅具体说明。 |
|
如何获取客户端 ID、客户端密码和 URL () |
请参阅具体说明。 |
|
具体说明 |
设置信息私密提供。 |
|
Help |
如有疑问，请联系 IST 支持团队。 |
LIBRUS
| SIS 供应商 |
LIBRUS |
|
软件的最低版本 |
当前版本 |
|
配置先决条件 |
客户必须具有 LIBRUS Synergia 许可证 |
|
如何获取客户端 ID、客户端密码和 URL () |
若要启用与 SDS 的 API 集成，必须以管理员或校长身份登录。 导航到“设置>”配置>“其他选项 > Office 365 集成 |
|
具体说明 |
帮助部分提供了详细说明。 |
|
Help |
请联系我们的支持团队 pomoc@LIBRUS.pl |
MySchool
| SIS 供应商 |
MySchool Ltd |
|
软件的最低版本 |
不适用 |
|
配置先决条件 |
通过支持团队协助 MySchool 系统的初始设置。 |
|
如何获取客户端 ID、客户端密码和 URL () |
通过支持团队提供协助。 |
|
具体说明 |
可在此处找到支持 |
|
Help |
联系我们 |
Rediker Software
| SIS 供应商 |
Rediker Software 的 TeacherPlus 成绩簿 |
|
软件的最低版本 |
1.12.0.0 |
|
配置先决条件 |
无。 默认情况下，所有学校都启用 OneRoster 集成。 |
|
如何获取客户端 ID、客户端密码和 URL () |
创建新学校时由程序自动生成。 管理员可以通过成绩簿管理器应用程序管理用户设置。 |
|
具体说明 |
无 |
|
Help |
问题可以定向到 GBSupport@rediker.com 或 APSupport@rediker.com |
SIMS
Skool
| SIS 供应商 |
Skool |
|
软件的最低版本 |
需要 Miloo+ 服务才能启用学校数据同步 |
|
配置先决条件 |
请联系 Skool 的客户经理以设置和启用 SDS。 |
|
如何获取客户端 ID、客户端密码和 URL () |
不适用 |
|
具体说明 |
不适用 |
|
Help |
请致电 (+31) 40 750 77 77 或发送电子邮件至 servicedesk@skool.nl联系 Skool 支持人员。 |
Skyward
SmartSchool
| SIS 供应商 |
SmartSchool |
|
软件的最低版本 |
产品是 SaaS 解决方案。 所有客户端都具有最新版本。 |
|
配置先决条件 |
无特定先决条件 |
|
如何获取客户端 ID、客户端密码和 URL () |
在软件中，转到“常规配置”、“OneRoster 客户端”，然后按照那里的说明进行操作。 |
|
具体说明 |
不适用 |
|
Help |
客户可以通过已知的支持渠道联系 SmartSchool。 |
Synergy SIS
| SIS 供应商 |
Edupoint 的 Synergy SIS |
|
软件的最低版本 |
2022 |
|
配置先决条件 |
OneRoster API 许可证密钥 |
|
如何获取客户端 ID、客户端密码和 URL () |
联系 Edupoint 支持人员 |
|
具体说明 |
不适用 |
|
Help |
https://support.edupoint.com/ |
Trivium
Vigilo
| SIS 供应商 |
Vigilo |
|
软件的最低版本 |
无 |
|
配置先决条件 |
无 |
|
如何获取客户端 ID、客户端密码和 URL () |
联系 Vigilo。 |
|
具体说明 |
无 |
|
Help |
请联系 Vigilo 以获取整个流程的支持。 |
Visma InSchool
| SIS 供应商 |
Visma Enterprise AS |
|
软件的最低版本 |
无 |
|
配置先决条件 |
无 |
|
如何获取客户端 ID、客户端密码和 URL () |
联系 Visma 支持部门 |
|
具体说明 |
联系 Visma 支持部门 |
|
Help |
请联系 Visma 支持部门。https://inschool.zendesk.com |
VULCAN UONET+
| SIS 供应商 |
VULCAN UONET+ |
|
软件的最低版本 |
Current |
|
配置先决条件 |
客户端必须具有 UONET+ 许可证 |
|
如何获取客户端 ID、客户端密码和 URL () |
从 VULCAN 管理员门户;选择“配置”“ > Office 365 设置” > API 交换配置。 启用“与 Office 365 同步”。 在此选项卡上，你将收到客户端 ID、客户端密码和 URL () 。 |
|
具体说明 |
不适用 |
|
Help |
请在标准办公时间内联系支持 https://vulcan.edu.pl 人员。 |