Microsoft Learn 目錄 API 常見問題
本文列出有關 Microsoft Learn 目錄 API 的常見問題,並視需要提供解答和詳細信息的連結。
一般
問:使用 Learn 目錄 API 需要多少費用?
使用 Learn 目錄 API 不需要任何成本。 如需詳細資訊,請參閱 Learn 目錄 API 功能概觀一文的可用性和定價一節。
問:使用 Learn 目錄 API 的規則為何?
請參閱 Microsoft Learn 和 Microsoft API 使用規定。
問:我需要上線或取得密鑰才能使用 Learn 目錄 API 嗎?
不。 API 已公開提供。 請參閱使用 cURL 和 Visual Studio Code 開始使用 Learn 目錄 API 一文, 和/或 Learn 目錄 API 開發人員參考文章。
問:此 API 會讓我們的使用者在我們的平台內取用 Learn 內容嗎?
不。 學習目錄 API 提供有關內容的元數據,以及直接連結至內容。 用戶可以根據 Microsoft API 使用規定,將這些連結整合到任何學習管理系統 (LMS) 或 Web 體驗。
問:從 Learn 目錄 API 傳回的數據是否保持靜態或變更?
每當新增、修改或刪除新內容時,數據就會變更,這通常是每天。
API 回應
問:我可以一次擷取所有數據嗎?
是的。 使用基本端點,learn.microsoft.com/api/catalog 來取得完整的回應。 如需詳細資訊,請參閱 Learn 目錄 API 開發人員參考文章。
問:我可以預先篩選回應嗎?
是的。 請參閱 Learn 類別目錄 API 開發人員參考文章中提供的查詢篩選。
問:每個內容物件的 UID 是否是唯一的?
是的。 UID 代表「唯一標識碼」,而且對每個內容物件而言都是唯一的。 如果 UID 變更,即使標題或其他元數據保持不變,內容也會被視為新的 物件。
問:為什麼課程模組的摘要中有 HTML 標記?
我們通常會嘗試盡可能保持摘要的格式設定,但有時我們需要強調或連結特定文字。
問:為什麼沒有個別單位的連結?
單元不會寫入為獨立內容。 它們應按模組的特定順序進行。 基於這個理由,我們會包含模組詳細數據頁面和第一個單元的連結,讓用戶能夠從該處開始並繼續進行內容。
問:如何告訴哪些內容是新的?
last_modified值會告訴您上次修改記錄的時間。
問:是否已啟用內容連結的單一 Sign-On (SSO?
目前不是。 我們的目標是在未來啟用 SSO。
內容
問:UID 是否對內容而言是唯一的?
是的。 UID 代表「唯一標識碼」,而且對每個內容物件而言都是唯一的。 如果 UID 變更,即使標題或其他元數據保持不變,內容也會被視為新的 物件。
問:所有課程模組是否都是學習路徑的一部分?
不。 模組全都能夠獨立運作,也就是說,模組會完整地教導其內的案例或概念,而且不需要修習任何先決條件模組。 對於某些人來說,這是它,它們不是學習路徑的一部分。 對於其他人來說,它們會組合在一或多個學習路徑中,透過建置更進階的概念來引導使用者。 模組不一定是學習路徑的一部分,也可以是一或多個課程模組的一部分。
問:如何知道何時新增、重新整理或刪除內容?
新增內容物件時,它們會顯示為回應中的新物件(由 UID 識別)。 當內容被修改時,您可以根據其最後修改值來判斷。 刪除內容時,內容物件會從回應中移除。 雖然 API 回應中更新的內容有時會稍有延遲,但當使用者遵循內容的 URL 時,他們一律會看到最新的資訊。 刪除內容時,舊 URL 會重新導向至新的內容或體驗,或重新導向至下一個最佳選項。
值得注意的是,內容會隨時更新。 我們每天發佈兩次可用的更新。 它們可能是次要的,例如次要文字變更,或主要,例如主要修訂、新增或刪除。 一般而言,內容組合被管理成一個大型且受高度控制、擁有數千名貢獻者的開放原始碼專案,因此變更不斷發生。 如果您在生產系統中使用 Learn 目錄 API,您應該注意這一點,並讓系統能夠處理它。
問:我遵循內容書籤連結,但現在它顯示的內容與我預期的不同。 為什麼?
我們努力確保沒有人因為我們網站的連結遇到死路(404)。 修改或取代內容時,我們會針對會自動帶您前往新內容的舊鏈接實作重新導向。 如果內容已不再使用且因各種原因未被替換,我們會重新導向至下一個最合適的內容,這可能是稍微修改過的內容範疇,或著陸頁面等。
問:如何存取檔、影片和程式代碼範例目錄?
目前沒有程序設計方式可存取這些目錄。 我們的目標是在未來啟用對這些目錄的程式設計存取。
地方化
問:Microsoft Learn 中有哪些語言可供使用?
Microsoft Learn 中有超過 65 個地區設定可供使用。 您可以透過網站頁尾在這裡看到完整清單(選取您要檢視的語言以查看完整清單)。
問:內容是否適用於其他語言?
這取決於。 我們的目標是提供內容中所教導產品的所有語言內容。 當學習者在指定的地區設定中流覽Microsoft Learn 網站時,如果該地區設定中沒有內容,使用者就會在所需的地區設定中看到頁首和頁尾,而核心內容預設會回到英文,直到有當地語系化版本可用為止。
問:特定內容對象的內容是否不同,取決於您在哪個語言中檢視它?
可能。 當更新發佈至英文內容時,我們的當地語系化管線會努力儘快更新當地語系化版本,通常是在原始變更后的幾天內。
其他
問:是否有任何報告 API 或功能可取得檢視、點選、完成等數據?
我們目前沒有報告 API。 我們確實具備 組織報告功能,可讓組織報告他們的使用者完成情況。
後續步驟
您可以瀏覽下列連結,以深入瞭解學習類別目錄 API: