OneRoster 提供者概觀

OneRoster API (應用程式介面) 是一種行業Standard格式，來自 1EdTech (以前稱為 IMS Global) ，用於交換學生資訊系統 (SIS) /學生管理系統 (SMS) 資料。 使用此同步處理方法，您可以使用 SIS/SMS 提供者所開發的 REST 型 OneRoster 1.1 API 直接連線到 SIS/SMS。 API支援可讓您直接同步資料，而不是使用CSV (逗號分隔值) 檔案。

使用 OneRoster API 來擷取數據，可讓您點亮核心 SDS 功能以進行布建。 它也可讓您增強 Microsoft 365 產品和功能的體驗。 OneRoster API 是我們如何從 SIS/SMS 同步處理物件，透過 學校數據同步 (SDS) 平臺提供 OneRoster API。

如需如何設定租用戶以使用 OneRoster API 做為來源的詳細資訊，請 使用 OneRoster API 進行資料擷取。

OneRoster 提供者狀態和功能

我的提供者未列在下拉式清單中，且此處的狀態顯示為「測試」。 我需要做什麼才能在提供者清單中看到它們？

• 請連絡 客戶支援團隊 ，以轉載您的租用戶，並取得目前 測試的 API 提供者的存取權。 提出請求時分享以下信息：

  • 租用戶識別碼
  • OneRoster 提供者名稱
  • SDS 版本
  • 名冊

• 租使用者出動之後，請與您的 OneRoster 提供者和 SDS POC 合作，以執行測試，並確保整合成功。 如果您遇到任何問題，請與提供者和 SDS POC 合作以解決這些問題。

• 測試成功之後，OneRoster 提供者狀態會從測試模式更新 (為是) ，並在所有租用戶的公開存取提供者清單中取得。

我的提供者未列出。 是否有資訊可以與他們共用，以 SDS 的 OneRoster 提供者身分參與？

• 與您的提供者共用下列文章 使用 SDS 的 OneRoster API 提供者上線指引。 本文包含要求新增為 OneRoster 提供者所需的步驟，包括先進入測試模式，然後最終進入公用清單以供租用戶選取之前進行測試和驗證。

擷取名冊資料時會存取哪些端點？

• 下列清單可協助您進一步瞭解透過 OneRoster API 連線到 SIS/SMS 時所存取的資料。

SDS 的必要 API 端點

SDS 的選擇性 API 端點

選擇性使用者學生聯絡關係

可以為學生用戶指定學生聯繫關係，以增強與家長和監護人溝通的教育者體驗。 聯絡人是提供 /users 的更多使用者，並且與學生的關聯可以在學生的使用者記錄中的「客服人員」下找到。

• 如需詳細資訊，請參閱 SDS 支援的支援學生連絡關係角色 ，請參閱 預設值清單：連絡人關聯性角色。

• 具有連絡人/監護人角色的使用者需要 familyName、givenName 和 email。

• 預計電話和短信是 E.164 中，並且必須包含 +。 (範例：+1234567890)

• 如果提供反向資料，則從聯絡人關係監護人記錄到聯絡人使用者「客服專員」欄位中的學生，這些記錄將被過濾掉。

選用使用者人口統計標記

可以為學生用戶指定用戶標誌，以表明他們參與計劃或隊列。 當使用者) 為 true 時，會 (包含使用者旗標，如果不適用，則不包含。

旗標會指定為使用者的中繼資料延伸模組，在中繼資料欄位中，在 Key|價值對。 索引鍵應該命名為 microsoft.userFlags，而且必須格式化為逗號分隔清單。 使用者旗標可以以任何順序顯示，而且不區分大小寫。

如需詳細資訊，請參閱 SDS 支援的使用者旗標值預設清單 ，請參閱 預設值清單：使用者旗標。

例如:

{ 
  "user" : { 
   … 
   … 
    "metadata" : { 
     "microsoft.userFlags" : "freeLunch,homeless,giftedOrTalented“ 
    } 
}

需要 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 整合。
• 提供者必須選擇實作 OAuth1 () 或 OAuth 2.0， (用戶端認證授予) 驗證配置。 OAuth 2.0 是首選。
• 如果支援的驗證通訊協定是 「OAuth 2.0」 - 用戶端認證授與類型，SDS 會在 「授權」標頭中傳送認證。 依照 OneRoster 規格中的建議，我們會在權杖要求的 Authorization 標頭中傳送編碼的用戶端認證。

OneRoster 提供者詳細資料

埃奎塔斯

Aeries

Arbor Education

Blackbaud 教育管理

泡泡

ClassLink

班級

Edge Learning

社區品牌教育

Edulife Connect

eSchoolData

eSchooling

音校SIS

Eventful

事實

焦點學校軟件

福萊特·阿斯彭

弗隆校基地

INACAP SDS API

無限學習

Infinite Campus

inLogic

IRIS 的 iSAMS

IST

LIBRUS

MySchool

Rediker Software

Capita SIMS

Skool

Skyward

智慧學校

Synergy SIS

Trivium

Vigilo

維斯瑪在學校

VULCAN UONET+