OneRoster 提供程序概述
本文内容
OneRoster API (应用程序编程接口) 是一种行业标准格式，从 1EdTech (以前是 IMS Global) ，用于交换学生信息系统 (SIS) /学生管理系统 (短信) 数据。 使用此同步方法，可以使用 SIS/SMS 提供程序开发的基于 REST 的 OneRoster 1.1 API 直接连接到 SIS/SMS。 API 支持允许直接同步数据，而不是使用 CSV (逗号分隔值) 文件。
使用 OneRoster API 引入数据可以照亮核心 SDS 功能进行预配。 它还允许你增强 Microsoft 365 产品和功能的体验。 OneRoster API 是我们从 SIS/SMS 同步对象的方式，这些 SIS/SMS 通过学校数据同步 (SDS) 平台提供 OneRoster API。
有关如何将租户设置为使用 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
/用户
status
dateLastModified
/users？offset=0&limit=5000&filter=status='active'/users？filter=dateLastModified>'{deltaDateTime}'
GetAllClasses
/类
status
dateLastModified
/classes？offset=0&limit=5000&filter=status='active'/classes？filter=dateLastModified>'{deltaDateTime}'
GetAllEnrollments
/入学 人数
status
dateLastModified
/enrollments？offset=0&limit=5000&filter=status='active'/enrollments？filter=dateLastModified>'{deltaDateTime}'
SDS 的可选 API 终结点
注意
对于人口统计数据、学生联系人关系和学生用户标志的可选数据部分，你是否包含此数据的能力将基于 SIS/SMS OneRoster 提供程序配置文件中支持的可选数据功能。 如果 SIS/SMS 提供程序也支持此数据，你将看到默认 (切换) 选择“ 打开 ”以包含其他数据。 如果需要，可以选择关闭开关。 如果切换开关不可用、显示但关闭且不可用于交互，则表示提供程序的配置文件当前不支持提供该数据。
注意
如果提供商的个人资料显示人口统计、联系人或用户人口统计标志不可用，并且你希望他们支持该功能，请联系提供商并请求添加支持，以启用 SDS 引入数据并允许你启用数据支持的方案和体验。
操作
URL
所需的筛选器属性
可选/建议的筛选器
示例
GetAllCourses
/课程
status
dateLastModified
/courses？offset=0&limit=5000&filter=status='active'/courses？filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics
/人口
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 将在“Authorization”标头中发送凭据。 按照 OneRoster 规范中的建议，我们会在令牌请求的 Authorization 标头中发送编码的客户端凭据。
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
SIS 供应商
Aeries
软件的最低版本
v8.18.6.29 或更高版本
配置先决条件
请参阅 OneRoster API 设置 。
如何获取客户端 ID、客户端密码和 URL ()
自承载。 请参阅 OneRoster API 设置 。
特定说明
不适用
Help
通过电话 (免费) 联系支持人员： (888) 324-5363 或 support@aeries.com
Arbor Education
SIS 供应商
Arbor Education
软件的最低版本
不适用
配置先决条件
Arbor MIS 与 SDS 之间的集成在 Arbor MIS 上启用。 请联系 Arbor 的帐户经理，确保通过 accountmanagers@arbor-education.com启用它。 必须具有Office 365教育租户、全局管理员权限和学校数据同步 (计划 1) 。
如何获取客户端 ID、客户端密码和 URL ()
在 Arbor MIS 中生成。 Arbor 帮助中心详细介绍了要完成的步骤。
特定说明
请联系 Arbor 或你的专用支持合作伙伴，通过 myteam@arbor-education.com帮助设置此集成。
Help
在 Arbor 的帮助中心查找支持文章。 对于问题，请联系 myteam@arbor-education.com 或你的专用支持合作伙伴。
Blackbaud Education Management
SIS 供应商
Blackbaud Education Management
软件的最低版本
最新版本的 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
rostersupport@classlink.com电子邮件 。
Classter
Edge Learning
社区品牌教育
SIS 供应商
社区品牌教育
软件的最低版本
不适用
配置先决条件
不适用
如何获取客户端 ID、客户端密码和 URL ()
联系客户支持。
特定说明
联系客户支持。
Help
如需支持，请联系 educate_support@communitybrands.com。
Edulife Connect
SIS 供应商
Edulife Connect
软件的最低版本
不适用
配置先决条件
不适用
如何获取客户端 ID、客户端密码和 URL ()
直接与我们的部署和支持团队联系完成。
特定说明
不适用
Help
请通过 support@wizkids.co.uk联系支持人员。 // 020 7550 9286
eSchoolData
SIS 供应商
eSchoolData
软件的最低版本
不适用
配置先决条件
地区必须是 eSD GURU 产品的订阅者。
如何获取客户端 ID、客户端密码和 URL ()
请参阅具体说明。
特定说明
若要启用 API 与 SDS 集成，区域管理员必须先在 GURU 中创建供应商帐户。 导航到“配置 > 供应商”，然后选择“创建新供应商”。 输入供应商名称，并保留自动生成的客户端 ID 和客户端密码。 配置 SDS 集成时，提供区域 GURU API URL。 选择“下一步”并启用所有 OneRoster API 权限。 完成后，选择“完成”以保存新帐户。
Help
有关问题，请联系 eSchoolData 支持团队。
eSchooling
SIS 供应商
Codevision 的 eSchooling
软件的最低版本
1.1.20
配置先决条件
None
如何获取客户端 ID、客户端密码和 URL ()
按照 eSchooling 平台中的说明操作：系统管理 > 学校数据同步
特定说明
与上一个相同
Help
联系 suporte@codevision.pt
Eum School SIS
SIS 供应商
DataEum
软件的最低版本
不适用
配置先决条件
None
如何获取客户端 ID、客户端密码和 URL ()
Email客户支持来请求 OneRoster API 凭据。
特定说明
联系客户支持 pbd@dataeum.kr
Help
联系客户支持 pbd@dataeum.kr
Eventful
SIS 供应商
Eventful
软件的最低版本
可以在 Eventful OneRoster 中找到受支持的学生注册列表。
配置先决条件
通过电子邮件联系 Eventful，或 info@eventful.se 致电 (+46) 10 209 9001
如何获取客户端 ID、客户端密码和 URL ()
在设置过程中提供。
特定说明
不适用
Help
通过电子邮件或电话联系 Eventful 支持人员 info@eventful.se (+46) 10 209 9001
事实
SIS 供应商
事实
软件的最低版本
不适用。 最新版本始终可供客户使用。
配置先决条件
不适用
如何获取客户端 ID、客户端密码和 URL ()
注册 OneRoster API 的客户和 FACTS 会向他们提供此信息。
特定说明
在 SIS 中，转到“系统>配置 SIS 集成>”“OneRoster API >> 填写”窗体。
Help
客户支持 866-800-6593
Focus School Software
SIS 供应商
Focus School Software
软件的最低版本
Focus v 8.7
配置先决条件
不适用
如何获取客户端 ID、客户端密码和 URL ()
在焦点门户屏幕中，“设置 > 系统设置 > 第三方系统”。 在记录插入行中，输入，标题：Microsoft版本 1.0 > 方言：OneRoster。 保存后，将生成 URL、客户端 ID 和客户端密码。
特定说明
不适用
Help
拨打 Focus 的电话支持热线 877-410-6637。
福利特·阿斯彭
SIS 供应商
福利特·阿斯彭
软件的最低版本
最新版本的 Aspen，5.9
配置先决条件
不适用
如何获取客户端 ID、客户端密码和 URL ()
请联系所在地区的客户关系经理来安排升级。
特定说明
不适用
Help
请联系客户关系经理寻求帮助。
Furlong Schoolbase
SIS 供应商
Furlong Schoolbase
软件的最低版本
仅使用最新版本的托管学校
配置先决条件
不适用
如何获取客户端 ID、客户端密码和 URL ()
可 在此处 找到说明。
特定说明
不适用
Help
使用 Furlong 开票。
INACAP SDS API
SIS 供应商
INACAP SDS API
软件的最低版本
不适用
配置先决条件
不适用
如何获取客户端 ID、客户端密码和 URL ()
INACAP 的本地系统，如有必要，请联系 sistemas@inacap.cl 。
特定说明
不适用
Help
通过电子邮件联系 INACAP 支持人员 sistemas@inacap.cl。
Infinitas Learning
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 用户界面 >> ，选择“系统管理 >> ”，选择“学习互操作性”
选择要同步的 Infinite Campus 中的属性时，请确保 未 选择时间段。 如果选择它，在隔离区中同步和锁定配置文件时，可能会生成大量错误。
Help
如需帮助，请联系你的客户成功经理。
inLogic
iSAMS by IRIS
SIS 供应商
iSAMS by IRIS
软件的最低版本
21.4.23.12
配置先决条件
None
如何获取客户端 ID、客户端密码和 URL ()
应通过电子邮件向支持人员发送请求 OneRoster API 凭据的地址 helpdesk@isams.co.uk
特定说明
None
Help
请联系 iSAMS 支持人员，在 helpdesk@isams.co.uk中请求帮助文档。
IST
SIS 供应商
IST
软件的最低版本
不适用。
配置先决条件
请参阅具体说明。
如何获取客户端 ID、客户端密码和 URL ()
请参阅具体说明。
特定说明
有关设置的信息是私下提供的。
Help
有关问题，请联系 IST 支持团队。
LIBRUS
SIS 供应商
LIBRUS
软件的最低版本
当前版本
配置先决条件
客户端必须具有 LIBRUS Synergia 的许可证
如何获取客户端 ID、客户端密码和 URL ()
若要启用 API 与 SDS 的集成，必须以管理员或学校校长身份登录。 导航到“设置”“>配置>”“集成”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 ()
创建新学校时由程序自动生成。 管理员可以通过 Gradebook Manager 应用程序管理用户设置。
特定说明
None
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 供应商
Synergy SIS by Edupoint
软件的最低版本
2022
配置先决条件
OneRoster API 许可证密钥
如何获取客户端 ID、客户端密码和 URL ()
联系 Edupoint 支持人员
特定说明
不适用
Help
https://support.edupoint.com/
Trivium
SIS 供应商
Trivium
软件的最低版本
1.0
配置先决条件
请联系 Trivium - Microsoft Partner 进行配置。
如何获取客户端 ID、客户端密码和 URL ()
请联系 Trivium - Microsoft合作伙伴生成客户端 ID 和机密。
特定说明
None
Help
https://www.trivium.com.br/contato/ 和 suporte@trivium.com.br
Vigilo
SIS 供应商
Vigilo
软件的最低版本
None
配置先决条件
None
如何获取客户端 ID、客户端密码和 URL ()
请联系 Vigilo。
特定说明
None
Help
通过此过程联系 Vigilo 以获取支持。
Visma InSchool
SIS 供应商
Visma Enterprise AS
软件的最低版本
None
配置先决条件
无
如何获取客户端 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 支持人员。