Microsoft Learn 目錄 API 功能概觀
Microsoft Learn 類別目錄 API 是以 REST 為基礎的 Web API,可讓您傳送 Web 型查詢,以Microsoft Learn 並取得可用訓練內容和認證測驗的詳細數據,例如標題、涵蓋的產品、層級、訓練連結,以及其他元數據,並傳回 JSON 編碼回應與資訊。
它會返回所有公開可用的資訊:
- 模組
- 單位
- 學習路徑
- 應用技能
- 認證
- 考試
- Instructor-Led 課程
注意
在最新的 Microsoft Learn 網站更新中,learn.microsoft.com 網域上有新的目錄 API 端點。 舊端點仍會如預期般運作,但切換至新端點的優點是,它會為您提供增強的功能,例如其他查詢參數。
使用案例
- 檢視Microsoft Learn 訓練和/或認證供應專案的元數據
- 提取 Microsoft Learn 的訓練和/或認證課程清單,以便能從您自己的線上平台連結到這些課程。
Learn 目錄 API 的運作方式
API 是以 REST 為基礎的 Web API,會傳回 JSON 編碼的回應。 若要要求完整目錄,請將 GET 要求傳送至:
https://learn.microsoft.com/api/catalog/
輸出看起來會類似下面的螢幕快照。 自 2022 年 11 月起,完整回應約為 13 MB。
每個學習目錄項目都是物件,每個項目都有一組可供使用的元數據。 完整數據字典和其他選項會列在 Microsoft Learn 目錄 API 開發人員檔中。 我們也提供版本資訊(連結),查看最新更新內容和最佳做法資訊。
如果您感興趣,請參閱 使用 cURL 和 Visual Studio Code 開始使用 Microsoft Learn 類別目錄 API 的文章。
要求
不需要驗證即可存取 Microsoft Learn 目錄 API。 使用者可以使用其慣用的 API 要求方法,例如 cURL、Postman 等。
例子
以下是我們看到使用者使用 Learn 目錄 API 的幾種方式:
- Viva Learning 已使用 Learn 目錄 API,在其核心功能中提供 Microsoft Learn 目錄。
- 組織和教育機構使用 Learn 目錄 API 來提取類別目錄資訊,並將其張貼在其內部學習管理系統 (LMS),因此其員工和學生可以輕鬆地存取它。
- 學習提供者會使用 Learn 目錄 API 來提取目錄資訊,並將其發布在客戶的學習體驗中。
可用性和定價
Microsoft Learn 目錄 API 已公開提供,並依據 Microsoft API 使用規定提供。 使用 API 並無費用。
局限性
- API 包含公開可用的課程模組、單元、學習路徑、講師導向的課程、測驗和認證。 目前不會輸出檔、程式代碼範例、顯示或事件。
- API 每天至少重新整理一次。
- API 版本的更新將會透過 Learn 類別目錄 API 版本資訊的更新來傳達。
後續步驟
若要深入瞭解 Learn 目錄 API,請檢閱下列文章:
- 使用 cURL 和 Visual Studio 開始使用 Microsoft Learn 目錄 API
- 學習目錄 API 常見問題