OneRoster 提供者概觀
OneRoster API (應用程式開發介面) 是業界標準格式，來自 1EdTech (先前的 IMS 全域) ，用於交換學生資訊系統 (SIS) /學生管理系統 (SMS) 數據。 使用此同步處理方法，您可以使用 SIS/SMS 提供者所開發的 REST 型 OneRoster 1.1 API，直接連線到 SIS/SMS。 API 支援可讓您直接同步處理數據，而不是使用 CSV (逗號分隔值) 檔案。
使用 OneRoster API 擷取數據可讓您亮起用於布建的核心 SDS 功能。 它也可讓您增強Microsoft 365產品和功能的體驗。 OneRoster API 是我們如何透過學校數據同步處理 (SDS) 平臺，從提供 OneRoster API 的 SIS/SMS 同步處理物件。
如需如何設定租使用者以使用 OneRoster API 作為來源的詳細資訊，請參閱使用 OneRoster API 擷取數據。
OneRoster 提供者的狀態和功能
我的提供者未列在下拉式清單中，此處的狀態會顯示為 [測試]。 我需要怎麼做才能在提供者清單中看到它們？
請連絡 客戶支援小組 以將租使用者正式發行前小眾測試版，並取得 API 提供者目前 測試的存取權。 提出要求時，請共用下列資訊：
- 租用戶識別碼
- OneRoster 提供者名稱
- SDS 版本
- 花名冊
一旦您的租使用者正式發行前小眾測試版，請與您的 OneRoster 提供者和 SDS POC 合作來執行測試，並確保整合成功。 如果您遇到任何問題，請與提供者和 SDS POC 合作，以解決問題。
測試成功之後，OneRoster 提供者狀態會從測試模式更新 (為 [是]) ，並可在所有租使用者的可公開存取提供者清單中取得。
未列出我的提供者。 是否有資訊可與他們共用，以透過 SDS 以 OneRoster 提供者身分參與？
擷取名冊數據時，會存取哪些端點？
- 下列清單可協助您進一步瞭解透過 OneRoster API 連線到 SIS/SMS 時所存取的數據。
SDS 的必要 API 端點
| 動作 |
URL |
必要的篩選屬性 |
選擇性/建議的篩選 |
範例 |
| GetAllAcademicSessions |
/academicSessions |
狀態 |
dateLastModified |
/academicSessions？offset=0&limit=5000&filter=status='active'/academicSessions？filter=dateLastModified>'{deltaDateTime}' |
| GetAllOrgs |
/orgs |
狀態 |
dateLastModified |
/orgs？offset=0&limit=5000&filter=status='active'/orgs？filter=dateLastModified>'{deltaDateTime}' |
| GetAllUsers |
/使用者 |
狀態 |
dateLastModified |
/users？offset=0&limit=5000&filter=status='active'/users？filter=dateLastModified>'{deltaDateTime}' |
| GetAllClasses |
/類 |
狀態 |
dateLastModified |
/classes？offset=0&limit=5000&filter=status='active'/classes？filter=dateLastModified>'{deltaDateTime}' |
| GetAllEnrollments |
/入學 人數 |
狀態 |
dateLastModified |
/enrollments？offset=0&limit=5000&filter=status='active'/enrollments？filter=dateLastModified>'{deltaDateTime}' |
適用於 SDS 的選擇性 API 端點
注意事項
針對人口統計、學生聯繫人關係和學生使用者旗標的選擇性數據片段，您包含此數據或不包含此數據的能力，將會以 SIS/SMS OneRoster 提供者設定檔中支援的選用數據功能為基礎。 如果 SIS/SMS 提供者也支援此資料，您會看到切換 (預設) 選取 [ 開啟 ] 以包含其他數據。 您可以視需要選取要關閉的切換開關。 如果切換無法使用、顯示但關閉，且無法進行互動，這表示提供者的配置檔目前不支援提供該數據。
注意事項
如果提供者的配置檔將人口統計、聯繫人或使用者人口統計旗標顯示為無法使用，而且您希望他們支援該功能，請連絡您的提供者並要求新增支援以啟用 SDS 來內嵌數據，並讓您啟用數據支援的案例和體驗。
| 動作 |
URL |
必要的篩選屬性 |
選擇性/建議的篩選 |
範例 |
| GetAllCourses |
/課程 |
狀態 |
dateLastModified |
/courses？offset=0&limit=5000&filter=status='active'/courses？filter=dateLastModified>'{deltaDateTime}' |
| GetAllDemographics |
/人口 |
狀態 |
dateLastModified |
/demographics？offset=0&limit=5000&filter=status='active'/demographics？filter=dateLastModified>'{deltaDateTime}' |
選擇性的用戶學生聯繫人關係
您可以為學生使用者指定學生聯繫人關係，以增強與家長和守護者通訊的授課者體驗。 聯繫人是更多使用 /users 提供的使用者，而與學生的關聯會在學生的用戶記錄中「代理程式」底下找到。
如需詳細資訊，請參閱 SDS 支援的受支援學生聯繫人關聯性角色， 請參閱預設值清單：聯繫人關聯性角色。
具有聯繫人/守護者角色的使用者需要familyName、givenName和電子郵件。
預期電話和簡訊必須包含在 E.164 和 + 中。 (範例： +1234567890)
如果提供反向數據，從聯繫人關係守護者記錄到聯繫人使用者 「代理程式」欄位中的學生，就會篩選掉這些記錄。
選擇性的使用者人口統計旗標
您可以為學生使用者指定使用者旗標，以表示他們參與計劃或世代。 當使用者) 為 true 時，會包含使用者旗標 (，如果不適用則不包含。
旗標會在元數據欄位中指定為使用者的元數據延伸模組，並遵循索引鍵|值組。 密鑰應該命名為 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 的用戶端識別碼
用來連線到 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 整合。
- 提供者必須選擇 () 或 OAuth 2.0 實作 OAuth1， (客戶端認證授與) 驗證配置。 偏好使用 OAuth 2.0。
- 如果支持的驗證通訊協定是 「OAuth 2.0」 - 客戶端認證授與類型，SDS 會在 “Authorization” 標頭中傳送認證。 如 OneRoster 規格中的建議，我們會在令牌要求的授權標頭中傳送編碼的客戶端認證。
OneRoster 提供者詳細數據
Aequitas
| SIS 廠商 |
Aequitas Solutions， Inc |
|
軟體的最低版本 |
Q 3.6.1，Q Web API 3.6.0 |
|
組態必要條件 |
請參閱 Q Web API 設定 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
請參閱 Q Web API 設定 |
|
特定指示 |
不適用 |
|
Help |
(909) 946-1600 連絡支持人員 |
Aeries
| SIS 廠商 |
Aeries |
|
軟體的最低版本 |
v8.18.6.29 或更新版本 |
|
組態必要條件 |
請參閱 OneRoster API 設定。 |
|
如何取得用戶端標識碼、客戶端密碼和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) 。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
在 Arbor MIS 中產生 。 Arbor 說明中心會詳細說明完成的步驟。 |
|
特定指示 |
請連絡 Arbor 或您的專用支援合作夥伴，以協助透過 myteam@arbor-education.com設定此整合。 |
|
Help |
在 Arbor 的說明中心尋找支援文章。 如有問題，請連絡 myteam@arbor-education.com 或您的專用支持合作夥伴。 |
Blackbaud 教育管理
| SIS 廠商 |
Blackbaud 教育管理 |
|
軟體的最低版本 |
最新版的 BEM 一律可供使用者使用。 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
此處說明逐步指示 |
|
特定指示 |
為 Microsoft Entra 用戶選取您的對應設定時，請確定要包含/排除網域後綴的設定符合您的 Microsoft Entra 用戶名稱。 此動作可確保將 BEM 學生和教師與您的 Microsoft Entra 使用者比對時獲得最佳結果。 |
|
Help |
support.blackbaud.com |
Bubblecon
| SIS 廠商 |
Bubblecon |
|
特定指示 |
與 Bubblecon 客戶支援小組聯繫。 |
ClassLink
| SIS 廠商 |
ClassLink |
|
軟體的最低版本 |
不適用 |
|
組態必要條件 |
在控制台中新增 SDS 應用程式。 選取 [ 新增應用程式 & 修改許可權 ]，以取得指示。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
客戶可以在新增應用程式之後，從控制台取得其 oAuth 認證。 電子郵件寄給設定應用程式之Microsoft的開發人員。 選取 [ 新增應用程式 & [修改許可權 ] 以顯示取得用戶端識別碼和秘密的位置。 |
|
如果連線發生問題，請確定 Web 存取 URL 具有 “/ims/oneroster/v1p1” 來指向正確的連接器。 |
|
特定指示 |
不適用 |
|
Help |
電子郵件 rostersupport@classlink.com。 |
Classter
Edge Learning
| SIS 廠商 |
Edge Learning |
|
軟體的最低版本 |
Edge 是 Web 應用程式，不需要最低版本。 |
|
組態必要條件 |
透過 OneRoster 在 Edge 應用程式 Microsoft 學校資料同步處理 中透過 「說明」取得 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
透過 OneRoster 在 Edge 應用程式 Microsoft 學校資料同步處理 中透過 「說明」取得 |
|
特定指示 |
透過 OneRoster 在 Edge 應用程式 Microsoft 學校資料同步處理 中透過 「說明」取得 |
|
Help |
透過 OneRoster 在 Edge 應用程式 Microsoft 學校資料同步處理 中透過 「說明」取得 |
依社群品牌進行教育
| SIS 廠商 |
依社群品牌進行教育 |
|
軟體的最低版本 |
不適用 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
請連絡客戶支持人員。 |
|
特定指示 |
請連絡客戶支持人員。 |
|
Help |
如需支援，請連絡 educate_support@communitybrands.com。 |
Edulife Connect
| SIS 廠商 |
Edulife Connect |
|
軟體的最低版本 |
不適用 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
直接與我們的部署和支援小組連絡完成。 |
|
特定指示 |
不適用 |
|
Help |
請連絡支持人員，support@wizkids.co.uk // 020 7550 9286 |
eSchoolData
| SIS 廠商 |
eSchoolData |
|
軟體的最低版本 |
不適用 |
|
組態必要條件 |
區域必須是 eSD GURU 產品的訂閱者。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
請參閱特定指示。 |
|
特定指示 |
若要啟用與 SDS 的 API 整合，區域系統管理員必須先在 GURU 內建立廠商帳戶。 流覽至 [組態 > 廠商]，然後選取 [建立新的廠商]。 輸入廠商名稱，並保留自動產生的用戶端標識碼和客戶端密碼。 設定SDS整合時，連同您的區域 GURU API URL 一起提供。 選取 [下一步] 並啟用所有 OneRoster API 許可權。 完成時選取 [完成] 以儲存新帳戶。 |
|
Help |
如有問題，請連絡您的 eSchoolData 支援小組。 |
eSchooling
| SIS 廠商 |
eSchooling by Codevision |
|
軟體的最低版本 |
1.1.20 |
|
組態必要條件 |
無 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
遵循 eSchooling 平臺中的指示：系統管理 > 學校數據同步 |
|
特定指示 |
與先前相同 |
|
Help |
聯繫 suporte@codevision.pt |
Eum School SIS
| SIS 廠商 |
DataEum |
|
軟體的最低版本 |
不適用 |
|
組態必要條件 |
無 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
Email 客戶支援要求 OneRoster API 認證。 |
|
特定指示 |
連絡客戶支持人員 pbd@dataeum.kr |
|
Help |
連絡客戶支持人員 pbd@dataeum.kr |
Eventful
| SIS 廠商 |
Eventful |
|
軟體的最低版本 |
您可以在 Eventful OneRoster 找到支持的學生註冊清單。 |
|
組態必要條件 |
透過電子郵件連絡 Eventful，網 (info@eventful.se +46) 10 209 9001 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
在安裝程式中提供。 |
|
特定指示 |
不適用 |
|
Help |
透過電子郵件連絡 Eventful Support， info@eventful.se 網 (+46) 10 209 9001 |
事實
| SIS 廠商 |
事實 |
|
軟體的最低版本 |
不適用。 最新版本一律可供客戶使用。 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
客戶註冊 OneRoster API，而 FACTS 會提供這項資訊給他們。 |
|
特定指示 |
從 SIS 內，移至系統>>設定 SIS 整合 > OneRoster API > 填寫表單。 |
|
Help |
客戶支援 866-800-6593 |
焦點學校軟體
| SIS 廠商 |
焦點學校軟體 |
|
軟體的最低版本 |
焦點 v 8.7 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
從焦點入口網站畫面中，設定 > 系統設定 > 第三方系統。 在記錄插入列上，輸入 Title： Microsoft Version 1.0 > Dialect： OneRoster。 儲存時，會產生URL、用戶端標識碼和客戶端密碼。 |
|
特定指示 |
不適用 |
|
Help |
撥打焦點電話支援線路 877-410-6637。 |
Follett Aspen
| SIS 廠商 |
Follett Aspen |
|
軟體的最低版本 |
最新版的 Aspen，5.9 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
請連絡您學區的客戶關係管理員以排程升級。 |
|
特定指示 |
不適用 |
|
Help |
請連絡您的客戶關係管理員以取得協助。 |
Furlong Schoolbase
| SIS 廠商 |
Furlong Schoolbase |
|
軟體的最低版本 |
僅使用最新版本的託管學校 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
您可以 在這裡找到指示。 |
|
特定指示 |
不適用 |
|
Help |
使用 Furlong 開啟票證。 |
INACAP SDS API
| SIS 廠商 |
INACAP SDS API |
|
軟體的最低版本 |
不適用 |
|
組態必要條件 |
不適用 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
INACAP 的內部部署系統，如有必要，請連絡 sistemas@inacap.cl 。 |
|
特定指示 |
不適用 |
|
Help |
透過電子郵件 sistemas@inacap.cl連絡 INACAP 支援， |
Infinitas Learning
Infinite Campus
| SIS 廠商 |
Infinite Campus |
|
軟體的最低版本 |
針對名冊布建，最低版本為 Campus.1821。 |
|
組態必要條件 |
建立 OAuth 用戶端 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
您可以在 Infinite Campus 的 OneRoster 指引中找到 oAuth 設定畫面的登入和尋找最新產品檔 |
|
特定指示 |
在 V 1933.3 之前 - 移至 Infinite Campus 使用者介面 >> 選取 [系統管理 >> ] 選取 [Campus Learning >> ] 選取 [OneRoster 工具 >> ] 選取 [OneRoster 工具]。 版本 1933.3 和更新版本 - 移至 Infinite Campus 使用者介面 >> 選取 [系統管理 >> ] 選取 [學習互操作性] |
|
選取 Infinite Campus 內要同步處理的屬性時，請確定 未 選取該期間。 如果已選取，則在同步處理並鎖定隔離中的配置檔時，可能會產生大量錯誤。 |
|
Help |
如需說明，請連絡您的客戶成功管理員。 |
inLogic
iSAMS by IRIS
| SIS 廠商 |
iSAMS by IRIS |
|
軟體的最低版本 |
21.4.23.12 |
|
組態必要條件 |
無 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
您應該透過電子郵件將要求 OneRoster API 認證的技術服務人員傳送至 helpdesk@isams.co.uk |
|
特定指示 |
無 |
|
Help |
請連絡 iSAMS 技術服務人員，以在 要求說明檔。helpdesk@isams.co.uk |
IST
| SIS 廠商 |
IST |
|
軟體的最低版本 |
不適用。 |
|
組態必要條件 |
請參閱特定指示。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
請參閱特定指示。 |
|
特定指示 |
安裝程序的資訊會私下提供。 |
|
Help |
如有問題，請連絡您的 IST 支援小組。 |
LIBRUS
| SIS 廠商 |
LIBRUS |
|
軟體的最低版本 |
目前版本 |
|
組態必要條件 |
客戶端必須擁有 LIBRUS Synergia 的授權 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
若要啟用與 SDS 的 API 整合，您必須以系統管理員或學校主體身分登入。 流覽至 [設定設定>>] [整合 Office 365 其他選項> |
|
特定指示 |
如需詳細指示，請參閱說明一節。 |
|
Help |
請連絡我們的支援小組， pomoc@LIBRUS.pl |
MySchool
| SIS 廠商 |
MySchool Ltd |
|
軟體的最低版本 |
不適用 |
|
組態必要條件 |
透過支援小組協助的 MySchool 系統初始設定。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
透過支援小組協助。 |
|
特定指示 |
您可以在這裡找到支援 |
|
Help |
連絡我們 |
Rediker Software
| SIS 廠商 |
TeacherPlus Gradebook by Rediker Software |
|
軟體的最低版本 |
1.12.0.0 |
|
組態必要條件 |
無。 預設會為所有學校啟用 OneRoster 整合。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
在建立新學校時由計劃自動產生。 管理員 可以透過 Gradebook Manager 應用程式管理用戶設定。 |
|
特定指示 |
無 |
|
Help |
問題可以導向或GBSupport@rediker.comAPSupport@rediker.com |
Capita SIMS
Skool
| SIS 廠商 |
Skool |
|
軟體的最低版本 |
需要 Miloo+ 服務才能啟用學校數據同步 |
|
組態必要條件 |
請連絡您的帳戶管理員與 Skool，以設定並啟用 SDS。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
不適用 |
|
特定指示 |
不適用 |
|
Help |
請連絡 Skool 支援，網 (+31) 40 750 77 77 或透過電子郵件寄送 servicedesk@skool.nl。 |
Skyward
SmartSchool
| SIS 廠商 |
SmartSchool |
|
軟體的最低版本 |
產品是 SaaS 解決方案，所有用戶端都有最新版本 |
|
組態必要條件 |
沒有特定的必要條件 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
在軟體中，移至 [一般設定]、[OneRoster 用戶端]，然後依照該處的指示操作。 |
|
特定指示 |
不適用 |
|
Help |
客戶可以透過已知的支援通道連絡 SmartSchool。 |
Synergy SIS
| SIS 廠商 |
Synergy SIS by Edupoint |
|
軟體的最低版本 |
2022 |
|
組態必要條件 |
OneRoster API 授權金鑰 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
連絡Edupoint支援 |
|
特定指示 |
不適用 |
|
Help |
https://support.edupoint.com/ |
Trivium
| SIS 廠商 |
Trivium |
|
軟體的最低版本 |
1.0 |
|
組態必要條件 |
請連絡 Trivium - Microsoft合作夥伴以進行設定。 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
請連絡 Trivium - Microsoft合作夥伴以產生用戶端標識碼和秘密。 |
|
特定指示 |
無 |
|
Help |
https://www.trivium.com.br/contato/ 和 suporte@trivium.com.br |
Vigilo
| SIS 廠商 |
Vigilo |
|
軟體的最低版本 |
無 |
|
組態必要條件 |
無 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
請連絡 Vigilo。 |
|
特定指示 |
無 |
|
Help |
請連絡 Vigilo 以透過程式取得支援。 |
Visma InSchool
| SIS 廠商 |
Visma Enterprise AS |
|
軟體的最低版本 |
無 |
|
組態必要條件 |
無 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
連絡 Visma 支援 |
|
特定指示 |
連絡 Visma 支援 |
|
Help |
請連絡位於的 https://inschool.zendesk.comVisma 支援。 |
VULCAN UONET+
| SIS 廠商 |
VULCAN UONET+ |
|
軟體的最低版本 |
目前 |
|
組態必要條件 |
用戶端必須擁有UONET+ 的授權 |
|
如何取得用戶端標識碼、客戶端密碼和URL () |
從 VULCAN 管理員 入口網站;選取 [設定] > [Office 365 設定] > API 交換組態。 啟用 「使用 Office 365 同步處理」。 在此索引標籤上，您會收到用戶端識別碼、客戶端密碼和 URL () 。 |
|
特定指示 |
不適用 |
|
Help |
請在 https://vulcan.edu.pl 標準上班時間連絡支持人員。 |