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 學習目錄 API 文章 和/或 學習目錄 API 開發人員參考文章 以開始使用。
問題:此 API 會讓我們的使用者在我們的平臺內取用 Learn 內容嗎?
否。 Learn 目錄 API 提供內容的相關中繼資料,以及內容的直接連結。 使用者可以根據 Microsoft API 使用條款 將這些連結整合到任何學習管理系統 (LMS) 或 Web 體驗中。
問題:從 Learn 目錄 API 傳回的資料是否保持靜態或有所變更?
每當新增、修改或刪除新內容時,資料就會變更,這通常是以每日為基礎。
API 回應
問題:我可以一次擷取所有資料嗎?
是。 使用基底端點,learn.microsoft.com/api/catalog 以取得完整的回應。 如需更多 API 要求資訊,請參閱 Learn 目錄 API 開發人員參考文章。
問題:我可以預先篩選回應嗎?
是。 請參閱 Learn 目錄 API 開發人員參考文章 中提供的查詢篩選條件。
問題:每個內容物件的 UID 是否是唯一的?
是。 UID 代表「唯一識別碼」,而且對每個內容物件而言都是唯一的。 如果 UID 變更,即使標題或其他中繼資料保持不變,內容也會被視為新的物件。
問題:為什麼課程模組的摘要中有 HTML 標籤?
我們通常會嘗試盡可能保持摘要原本的格式設定,但有時我們需要強調或連結特定文字。
問題:為什麼個別單元沒有連結?
單元不會寫入為獨立內容。 單元應按照課程模組的特定順序進行。 基於這個理由,我們會包含課程模組詳細資料頁面和第一個單元的連結,以便使用者從該處開始並照順序進行內容。
問題:如何判斷哪些是新內容?
last_modified 值可告訴您上次修改記錄的時間。
問題:是否已針對內容連結啟用單一登入 (SSO)?
目前不能。 我們的目標是在未來啟用 SSO。
Content
問題:UID 是否對內容而言是唯一的?
是。 UID 代表「唯一識別碼」,而且對每個內容物件而言都是唯一的。 如果 UID 變更,即使標題或其他中繼資料保持不變,內容也會被視為新的物件。
問題:所有課程模組是否都是學習路徑的一部分?
否。 課程模組全都能夠獨立存在,也就是說,課程模組會教導其內案例或概念端對端,而不需要採用必要條件課程模組。 對於課程模組來說,就是這樣,它們不是學習路徑的一部分。 對於其他課程模組來說,它們會以一或多個學習路徑組合在一起,引導使用者建置更進階的概念。 課程模組不一定要是學習路徑的一部分,或者也可以是一或多個學習路徑的一部分。
問題:我如何知道系統何時新增、重新整理或刪除了內容?
新增內容物件時,它們會顯示為回應中的新物件 (由 UID 識別)。 修改內容後,您可以根據其 last_modified 值來判斷。 當內容被刪除後,系統將會從回應中將內容物件移除。 雖然 API 回應中更新的內容有時會稍有延遲,但當使用者遵循內容的 URL 時,一律能看到最新的資訊。 內容被刪除時,舊的 URL 會重新導向至新的內容或體驗,或到下一個最佳選項。
值得注意的是,內容會隨時更新。 我們每天發佈兩次可用的更新。 它們可能是次要更新,例如次要文字變更,或主要更新,例如主要修訂版本、新增內容或刪除內容。 一般而言,內容組合會以具有成千上萬個參與者的龐大、高度控管開放原始碼專案來管理,因此,隨時都有變更。 如果您在生產系統中使用 Learn 目錄 API,您應該瞭解這點,並確定您的系統能夠進行處理。
問題:我從書籤連結前往內容,但現在它會顯示與我預期的不同內容片段。 為什麼?
我們努力確保沒人會抵達死胡同 (404) 與網站的連結。 修改或取代內容時,我們為舊連結實作重新導向,將您自動導引至新內容。 如果內容已被淘汰,且因各種原因尚未被取代,我們會重新導向至下一個最佳適當內容,這可能是稍微修改的範圍,或登陸頁面等等。
問題:如何取得文件、影片和程式碼範例目錄的存取權?
目前沒有程式設計方法可存取這些目錄。 我們的目標是在未來針對這些目錄啟用程式設計存取。
當地語系化
問題:Microsoft Learn 提供哪些語言?
Microsoft Learn 中有超過 65 個地區設定可供使用。 您可以透過網站頁尾 (選取您要檢視的語言以查看完整清單) 在這裡看到完整清單。
問題:內容是否提供其他語言?
要看情況而定。 我們的目標是提供內容中產品所教導的語言可供所有語言使用。 當學習者在指定的地區設定中瀏覽 Microsoft Learn 網站時,如果內容無法在該地區設定中使用,使用者會在其所需的地區設定中看到頁首和頁尾,而核心內容會預設回英文,直到有當地語系化版本可用為止。
問題:特定內容物件的內容是否取決於您使用哪個語言檢視而有所不同?
有可能。 當更新內容發佈至英文內容時,我們的當地語系化管線會努力儘快更新的當地語系化版本 - 通常會在原始變更後的幾天內完成。
其他
問題:是否有任何報表 API 或功能可取得資料,例如檢視、點選、完成?
我們目前沒有報表 API。 我們確實具有 組織報表功能,可讓組織回報其使用者完成狀況。
下一步
您可以瀏覽下列連結,以深入瞭解 Learn 目錄 API: