OneRoster 提供者概觀

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 是我們如何從 SIS/SMS 同步處理物件，透過學校資料同步處理 (SDS) 平台提供 OneRoster API。

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

OneRoster 提供者狀態和功能

我的提供者未列在下拉式清單中，且此處的狀態顯示 Test。 我該怎麼做，才能在提供者清單中看到它們？

• 請連絡 客戶支援小組 ，以讓您的租用戶進行正式發行前小眾測試，並取得目前 測試的 API 提供者存取權。 提出要求時，請分享下列資訊：

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

• 租用戶正式發行前小眾測試後，請與您的 OneRoster 提供者和 SDS POC 合作以執行測試並確保整合成功。 如果您遇到任何問題，請與提供者和 SDS POC 合作解決這些問題。

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

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

• 與您的提供者分享下列文章： 使用 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/簡訊啟用 OneRoster API 連線，您必須提供連線認證。 如需詳細資訊，請參閱特定提供者的文件以取得或產生它們。

• Web 存取 URL：SIS/簡訊可存取 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 提供至 SIS 的資料中包含特定學校，客戶必須與其提供者合作，以了解如何設定用來將 SDS 連結至 SIS 的連線/認證所包含的學校。
• 端點對篩選參數支援有需求，以允許依狀態篩選，或啟用差異同步。
• SDS 針對差異同步/累加同步處理的 dateLastModified 屬性套用篩選，且這是與 SDS 整合的必要項目。
• 提供者必須選擇實作 OAuth1 () 或 OAuth 2.0 (用戶端認證授與) 驗證配置。 優先使用 OAuth 2.0。
• 如果支援的驗證通訊協定為「OAuth 2.0」 - 用戶端認證授與類型，SDS 會在「授權」標頭中傳送認證。 依照 OneRoster 規格中的建議，我們會在權杖要求的授權標頭中傳送編碼的用戶端認證。

OneRoster 提供者詳細資料

Aequitas

Aeries

AI 資料

Arbor Education

Blackbaud 教育管理

Bubblecon

ClassLink

Classter

Edge Learning

由社群品牌教育

Edulife Connect

eSchoolData

eSchooling

Eventful

事實

Focus School 軟體

Follett Aspen

弗隆校基地

INACAP SDS API

Infinitas 學習

Infinite Campus

inLogic

iSAMS by IRIS

IST

LIBRUS

MySchool

Rediker Software

Capita SIMS

Skool

Skyward

SmartSchool

Synergy SIS

Trivium

Vigilo

Visma InSchool

VULCAN UONET+