Adobe Learning Manager開發人員手冊

最後更新： 2025年6月24日

概觀

Adobe Learning Manager提供RESTful API，讓開發人員能夠有效地整合及自訂應用程式或工作流程。 開發人員手冊提供如何使用這些API的指引，涵蓋驗證、資料模型以及與其他應用程式整合等主題。 此外，本指南API參考檔案可協助開發人員建立與Adobe Learning Manager各種功能互動的外部應用程式或後端工作流程，包括課程建立、追蹤學習者進度、技能對應、認證、gamification和成績單。

本手冊涵蓋下列內容：

  • OAuth2.0驗證
  • API物件模型
  • 顯示如何使用include、欄位和其他引數
  • 提供真實使用案例的端點
重要
本開發人員手冊僅涵蓋Adobe Learning Manager V2 API。 本指南中說明的所有範例、請求結構和驗證工作流程都特定於/primeapi/v2/端點。 如需舊版或已棄用API的詳細資訊，請參閱API參考檔案。

API使用案例

開發人員可以使用Learning Manager API來增強或整合Learning Manager與其他企業應用程式。 您可以使用任何技術建立網頁、案頭或行動應用程式。 開發人員可以在Learning Manager中存取應用程式資料，但部署是外部的，完全由您控制。 應用程式通常由客戶組織為他們的帳戶開發，而Adobe合作夥伴可以建立一般應用程式以供更廣泛使用。

使用OAuth 2.0進行驗證

若要安全地存取Adobe Learning Manager API，您必須使用ALM的OAuth 2.0機制進行驗證。 此程式包括註冊您的應用程式、產生授權代碼、將其交換為重新整理權杖，最後使用重新整理權杖來取得存取權杖。

註冊應用程式

將Adobe Learning Manager與外部應用程式整合，以強化多功能性。 這些步驟涉及存取整合管理員介面、註冊應用程式，以及取得使用者端ID和密碼。 從ALM產生驗證權杖（OAuth、重新整理和存取權杖），強調使用OAuth 2.0架構進行驗證和授權。 存取權杖的有效期為七天。

  1. 以整合管理員的身分登入Adobe Learning Manager。

  2. 在左窗格中選取​ Applications。

    替代文字

  3. 選取​ Register ​並新增下列資訊：

    • Application Name：輸入應用程式的名稱（最多50個字元）。

    • URL：您公司或應用程式的官方URL。 用於識別和參考。

    • Redirect Domains：指定ALM在授權後可重新導向的網域(例如http://learningmanager.adobe.com)。 您可以提及多個URL，但URL必須是有效的。

    • Description：應用程式功能的簡短說明。

    • Scopes：選取六個可用選項之一，以定義應用程式的範圍。 根據您在此處提及的選擇，您的應用程式可以存取Learning Manager API端點。 例如，如果您選擇學習者角色讀取存取權，則您的應用程式能以唯讀方式存取所有Learning Manager學習者API端點。

      • 管理員角色讀取/寫入存取權：允許應用程式以管理員身分存取或修改資料。
      • 學習者角色讀取/寫入存取權：允許應用程式存取或修改學習者的資料。
      • xAPI讀取/寫入存取權：讓應用程式可存取及傳送Experience API (xAPI)陳述式。

    • For this account only?

      • Yes — 如果您選擇[是]，則其他帳戶管理員看不到該應用程式。
      • No — 如果您選擇[否]，其他帳戶管理員也可以存取此應用程式，但他們需要使用應用程式ID來存取此應用程式。 應用程式ID會以Learning Manager應用程式的編輯模式產生和顯示。

      替代文字

  4. 選取​ Save ​以註冊應用程式。

    • 註冊應用程式後，可在帳戶中建立的應用程式清單中找到該應用程式。 選取應用程式，除了先前輸入的欄位外，您將會看到下列內容：
    • 應用程式ID：這是使用者端識別碼。 此ID會通知ALM要求存取權的應用程式。 它包含在API要求中，用來識別應用程式。
    • 應用程式密碼：這可用來在權杖交換步驟期間（例如，要求重新整理權杖或存取權杖時）驗證您的應用程式並驗證其身分。