使用 OneRoster API 擷取數據
OneRoster API (應用程式開發介面) 是業界標準格式，來自 1EdTech (先前的 IMS 全域) ，用於交換學生資訊系統 (SIS) /學生管理系統 (SMS) 數據。 使用此同步處理方法，您可以使用 SIS/SMS 提供者所開發的 REST 型 OneRoster 1.1 API，直接連線到 SIS/SMS。 API 支援可讓您直接同步處理數據，而不是使用 CSV (逗號分隔值) 檔案。
學校數據同步存取的數據
重要事項
藉由連線並讓機構數據可供學校數據同步使用，您會確認您有權與 Microsoft 共用此數據，並認可遵守貴組織的數據控管標準。
| 動作 | URL | 必要的篩選屬性 | 選擇性/建議的篩選 | 範例 |
|---|---|---|---|---|
| GetAllAcademicSessions | /academicSessions | 狀態 | dateLastModified | /academicSessions？offset=0&limit=5000&filter=status='active'/academicSessions？filter=dateLastModified>'{deltaDateTime}' |
設定 Microsoft 365 教育版 租使用者的 SDS
- Microsoft 365 教育版 租使用者
- 需要全域管理員許可權
SDS 存取和第一次登入
若要存取 SDS 管理員 入口網站啟動網頁瀏覽器，請流覽至 sds.microsoft.com，然後使用您的 Microsoft 365 全域 管理員 帳戶登入。
選取 [開始使用]。
選取 [繼續]。
在下一個步驟之前，請稍候一段時間，讓服務布建到租使用者。
選 取 [建立新的輸入流程]。 選取 [下一步] 繼續。
選擇您的數據來源。 針對 OneRoster API，您可以選取 [ 連線到我的數據] 選項。
選取格式。 針對 OneRoster API，您可以選取 [ API] 選項。 選取 [下一步] 繼續。
您必須從提供者清單中選取 SIS/SMS 提供者。 選取之後，選取 [ 下一步 ] 以繼續。
注意事項
如果您的 SIS/SMS 提供者不在清單中，請參閱 OneRoster 提供者概觀 ，以取得參與試驗測試的指示，或傳送至提供者以讓他們參與加入為 OneRoster 提供者的資訊。
若要啟用與 SIS/SMS 的連線，您必須提供連線認證。
Web 存取 URL：SIS/SMS 可存取 OneRoster API 的 URL
用來連線到 SIS/SMS OneRoster API 的用戶端識別碼
用來連線到 SIS/SMS OneRoster API 的客戶端密碼
存取令牌 URL，如果您的 SIS/SMS OneRoster API 已設定為使用 OAuth2 進行驗證，您也必須提供將用來連線的存取令牌 URL 端點。 端點與 Web 存取 URL 不同。
選取 [下一步] 繼續。
接下來，我們會根據最後一個畫面中輸入的信息，測試與 SIS/SMS 的連線。
如果沒有任何問題，系統會通知您，並可選取 [下一步 ] 繼續。
如果我們無法建立連線，您會收到通知，而且可以選取 [上一步 ] 來檢閱和更新提供的資訊。
選擇您目前的學年並提供易記名稱，例如 2023 或 2022 – 2023。 (字元必須是 utf8，否則會自動移除) 。
重要事項
學年是用來建立傳入數據的關聯，以協助建置年度歷程記錄數據。 此方法與學年與日曆年度一致。 例如，如果您的學年跨越日曆年度，從 2022/8/15 開始到 2023 年 6 月 15 日結束，則要選取的學年值就是 2023 年的結束年份。 如需詳細資訊，請參閱 學年處理
輸入學年開始和結束的日期。
根據提供者支持的選用數據功能，您會看到選取的切換開關 [開啟 (預設) 以包含其他數據。 您可以視需要選取要關閉的切換開關。 如果切換已關閉且無法開啟，這表示提供者的配置檔目前不支援提供選擇性數據。 如需提供者是否支援傳送選擇性數據的詳細資訊，請參閱 OneRoster API 提供者概觀。
輸入 SDS 應該根據此來源定義的學年停止同步處理數據的日期。 在您剛才輸入的學年結束日期停止同步處理數據最常見。
選取 [下一步] 繼續。
![提示 [學年] 和 [停止同步處理日期] 的螢幕快照。](images/data-ingestion-with-sds-or-api-12.png)
選取使用者身分識別規則選項。 同時為教職員和學生角色進行選擇。
注意事項
使用者比對是使用輸入流程來執行，而且不會寫入或更新 Microsoft Entra ID 中的用戶物件。 比對會執行並儲存在EducationData Lake中。 如需詳細資訊，請參閱 Microsoft 365 管理使用者 ，瞭解如何使用輸出流程向前寫入比對連結。
- 來源的屬性：以來自 SIS/SMS 的數據為基礎的用戶屬性。
- 可用的來源選項為 [用戶名稱] 和 [Email]。
- 要比對的屬性：要比對 Microsoft Entra ID 中的用戶屬性。
- 可用 Microsoft Entra ID 比對選項為 UserPrincipalName 和 Mail。
- (選擇性) 如果您的用戶數據不包含 @domain 值，請從清單中選取網域。
警告
選取網域是選擇性的，而且只有在以來源中選取 的屬性 為基礎的傳入數據不包含 @domain 值時，才應該使用。 如果記錄上遺漏值，SDS 不會 進行檢查並附加。 SDS 會將網域選取範圍附加至所有記錄，這些記錄可能會導致@domain@domain，而在這些實例中找不到與 Microsoft Entra ID 中使用者進行現有用戶對應的相符專案。
注意
如果 SIS/SMS 使用者，例如員工角色群組中的使用者，可以與@domain1或@domain2或@domain3您必須根據來源選取範圍中選取的屬性，在源數據中包含@domain (範例：prefix@domain) 。 您的屬性必須符合下列專案：UserPrincipalName 或 Mail，才能找到要比對的正確 Microsoft Entra 使用者。
OneRoster API v1.1 規格只允許每個用戶傳遞一個角色。 如果與多個組織相關聯，它只能將使用者的相同角色傳遞給多個組織。 由於每個組織都有一個角色，因此記錄會標示為isPrimary 'True'。
重要事項
設定 Microsoft 365 管理使用者流程時，如果啟用 [建立不相符的使用者] 選項來定義 Microsoft Entra UserPrincipalName 屬性的建構，則會使用這些規則。
在您滿意您的選擇之後，請選取 [ 下一步 ] 繼續。
![顯示使用者身分識別規則提示的螢幕快照。]](images/data-ingestion-with-sds-or-api-13.png)
- 來源的屬性：以來自 SIS/SMS 的數據為基礎的用戶屬性。
檢閱檢閱和建立上呈現的資訊。 如果一切看起來都正確，請選取 [ 下一步] 按鈕。 如果沒有，您就能夠巡覽回到正確。
![[檢閱並建立] 的螢幕快照。]](images/data-ingestion-with-sds-or-api-14.png)
![選取建立後處理的螢幕快照。]](images/data-ingestion-with-sds-or-api-15.png)
您的輸入數據流已建立，且第一次執行擱置中，請選取 [ 完成 ] 按鈕。 請回來查看您第一次執行的狀態。
![已建立輸入流程的螢幕快照。]](images/data-ingestion-with-sds-v21-csv-17.png)
![顯示 [首頁儀錶板] 和 [管理數據] 動作的螢幕快照。](images/manage-data-microsoft-365-1.png)
提示
您可以在定義 Connect 數據組態之後、使用中第一次執行期間，或在第一次執行完成之後，立即設定管理 數據 組態。
若要檢查執行狀態，請流覽回 [首頁] 儀錶板頁面。
如果您的數據沒有任何問題，[首頁] 儀錶板會指出「找不到數據錯誤或警告」和「我們在上次執行期間未遇到任何數據錯誤或警告。」 請繼續進行出色的工作！
如果您的數據有問題，[首頁] 儀錶板會通知「我們發現您的數據有一些問題」，並鼓勵您 調查同步處理健康情況。
![提示 [學年] 和 [停止同步處理日期] 的螢幕快照。](images/data-ingestion-with-sds-or-api-12.png#lightbox)
![顯示使用者身分識別規則提示的螢幕快照。]](images/data-ingestion-with-sds-or-api-13.png#lightbox)
![[檢閱並建立] 的螢幕快照。]](images/data-ingestion-with-sds-or-api-14.png#lightbox)
![選取建立後處理的螢幕快照。]](images/data-ingestion-with-sds-or-api-15.png#lightbox)
![已建立輸入流程的螢幕快照。]](images/data-ingestion-with-sds-v21-csv-17.png#lightbox)
![顯示 [首頁儀錶板] 和 [管理數據] 動作的螢幕快照。](images/manage-data-microsoft-365-1.png#lightbox)