應用程式開發人員手冊

概觀 overview

Adobe Learning Manager是雲端託管、以學習者為中心的自助式學習管理解決方案。 客戶可以使用Learning Manager API以程式設計方式存取Learning Manager資源，以便將其與其他企業應用程式整合。 Adobe合作夥伴也可以使用此API來增強Learning Manager的價值主張，方法是擴充其功能或將其與其他應用程式或服務整合。

使用案例 usagescenario

使用Learning Manager API，開發人員可以建置獨立的應用程式，以擴充Learning Manager的功能或將Learning Manager與其他企業應用程式工作流程整合。 您可以使用您選擇的任何技術來開發網頁應用程式、案頭使用者端或行動應用程式。 作為開發人員，您可以在Learning Manager中存取您的應用程式資料。 您開發的應用程式部署在Learning Manager平台的外部，而且您可以隨著應用程式的演化，完全控制軟體開發生命週期。 通常，應用程式是由客戶組織開發，以便與其Learning Manager帳戶搭配使用，而這些應用程式為該特定客戶組織專用。 此外，Adobe合作夥伴可以使用Learning Manager API建立通用應用程式，以供大量Learning Manager客戶使用。

Learning Manager API apidescription

Learning Manager API以REST原則為基礎，並透過HTTP向應用程式開發人員公開Learning Manager物件模型的關鍵元素。 在瞭解API端點和HTTP方法的詳細資訊之前，開發人員可以熟悉各種Learning Manager物件、其屬性和相互關係。 瞭解模型後，大致瞭解API要求和回應的結構，以及在API中普遍使用的幾個常用程式設計術語會很有用。

如需各種API端點和方法的詳細資訊，請參閱Learning Manager API檔案。

學習者API

Adobe Learning Manager — 學習者API可讓您為使用者建立自訂學習體驗。 這些API的使用需要有效的使用者權杖，且僅能用於具有完全授權/註冊學習者的工作流程中。

非登入使用案例需要特殊處理。

若您對這些API的適當使用有任何疑問，請洽詢解決方案架構團隊，並確定解決方案架構師已在您部署解決方案之前對其進行稽核。

API驗證 apiauthentication

撰寫可對Learning Manager進行API呼叫的應用程式時，您必須使用整合管理應用程式註冊您的應用程式。

Learning Manager API使用OAuth 2.0架構來驗證及授權您的使用者端應用程式。

程式

1. 設定您的應用程式

您可以使用使用者端ID和使用者端密碼來設定您的應用程式，以使用適當的端點。 註冊應用程式後，您就可以取得clientId和clientSecret。 「取得URL」應該用於瀏覽器，因為它會使用Learning Manager預先設定的帳戶(例如SSO、Adobe ID等)來驗證Learning Manager使用者。

GET https://learningmanager.adobe.com/oauth/o/authorize?client_id=<Enter your clientId>&redirect_uri=<Enter a url to redirect to>&state=<Any String data>&scope=<one or more comma separated scopes>&response_type=CODE.

成功驗證後，瀏覽器會重新導向至上述URL中提及的redirect_uri。 引數​ 代碼 ​會與重新導向URI一起附加。

2。 從程式碼 ​取得重新整理權杖

POST https://learningmanager.adobe.com/oauth/token Content-Type: application/x-www-form-urlencoded

post要求內文：

client_id:
<enter your clientid>
 &
 client_secret:
 <enter your clientsecret>
  &
  code:
  <code from step 1></code>
 </enter>
</enter>

3。 從重新整理權杖取得存取權杖

取得存取權杖的URL：

POSThttps://learningmanager.adobe.com/oauth/token/refresh內容型別： application/x-www-form-urlencoded

post要求內文：

client_id:
<enter your clientid>
 &
 client_secret:
 <enter your clientsecret>
  &
  refresh_token:
  <refresh token>

  </refresh>
 </enter>
</enter>

驗證存取權杖詳細資料的URL

GET https://learningmanager.adobe.com/oauth/token/check?access_token=<access_token>

使用量限制

存取權杖的有效期為七天。 一天後，您必須使用重新整理權杖產生新的存取權杖。 如果您在現有存取權杖仍然有效的情況下，從重新整理權杖產生新的存取權杖，則會傳回現有的權杖。

以下說明Learning Manager API中的部分常用辭彙，以供您參考。

包含

開發人員可以存取單一API物件模型，也可以存取與該模型關聯的多個模型。 若要存取後續的相關模型，您需要瞭解每個模型與其他模型的關係。 Include ​引數可讓開發人員存取相依模型。 您可以使用逗號分隔符號來存取多個模型。 如需​ 包含 ​的範例使用方式與詳細資訊，請參閱此頁面的範例API模型區段。

API要求

API要求可透過發出HTTP要求來進行。 根據端點和方法，開發人員可以選擇各種HTTP動詞，例如GET、PUT、POST、DELETE、PATCH等。 對於某些請求，可傳遞查詢引數。 請求特定資料模型時，使用者也可請求相關模型，如JSON API規格所述。 典型API要求的結構在範例模型用法中說明。

API回應

當使用者端提出API請求時，會根據JSON API規格取得SON檔案。 回應也包含HTTP狀態代碼，開發人員可驗證此代碼，以便在其應用程式邏輯中執行適當的後續步驟。 典型API回應的結構在範例模型用法中說明。

個錯誤

當API要求失敗時，會取得錯誤回應。 回應中傳回的HTTP狀態代碼表示錯誤的性質。 在API參考中，每個模式的錯誤代碼都會以數字表示。 200、204、400和404是API中表示的一些常見錯誤，指出HTTP存取問題。

欄位

API物件的屬性及其關系統稱為「欄位」。 如需詳細資訊，請參閱JSON API。您可在進行API呼叫以從模型中擷取一或多個特定屬性時，使用Fields作為引數。 在沒有Fields引數的情況下，API呼叫會從模型中擷取所有可用的屬性。 例如，在下列API呼叫中，欄位[skill]=name會單獨擷取技能模型的name屬性。

https://learningmanager.adobe.com/primeapi/v2/users/{userId}/userSkills/{id}?include=skillLevel.skill&fields[skill]=name

分頁

有時，API要求會導致回應中傳回一長串物件。 在這種情況下，分頁屬性可讓開發人員依序擷取多個頁面的結果，其中每個頁面都包含一系列記錄。 例如，Learning Manager中的分頁屬性可讓您設定要在頁面中顯示的最大記錄數。 您也可以定義要在頁面上顯示的記錄範圍值。

排序

API模型允許排序。 根據模型，選擇要套用至結果的排序型別。 排序可以遞增或遞減順序套用。 例如，如果您指定code sort=name，則會依名稱遞增排序。 如果您指定code sort=-name，則會依名稱降序排序。 如需詳細資訊，請參閱JSON API規格。

API使用圖例 samplemodel

讓我們考慮一個案例，其中開發人員想要取得技能名稱、為技能層級指派的最大點數，以及學習者因該技能而獲得的點數。

Learning Manager API中的userSkill模型包含id、型別、dateAchieved、dateCreated、pointsEarned等預設屬性。 因此，當開發人員使用GET方法取得userSkill模型的詳細資訊時，與預設屬性相關的目前資料會顯示在回應輸出中。

但是，在此案例中，開發人員想要取得使用者的技能名稱和技能層級。 Learning Manager API可讓您使用關係欄位和包含引數來存取此相關資訊。 userSkill的相關模型可在關係標籤中取得。 您可以隨userSkill一起呼叫這些模型，以取得每個相關模型的詳細資訊。 若要取得此資訊，請為每個關聯的模型使用具有點（句點）分隔值的​ code include ​引數。 您可以使用逗號作為分隔符號來請求另一個模型，例如user include=skillLevel.skill，course

API呼叫

https://learningmanagerqe1.adobe.com/primeapi/v1/users/%7buserId%7d/userSkills/%7bid%7d?include=skillLevel.skill&fields%5bskill%5d=name&fields%5bskillLevel%5d=maxCredits&fields%5buserSkill%5d=pointsEarned

例如userId可以是746783，userSkills id可以是746783_4426_1。

API呼叫的回應

\{
 "links": {"self": "https://learningmanager.adobe.com/primeapi/v2/users/746783/userSkills/746783_4426_1?include=skillLevel.skill&fields[userSkill]=pointsEarned&fields[skillLevel]=maxCredits&fields[skill]=name"},
 "data": {
 "id": "746783_4426_1",
 "type": "userSkill",
 "attributes": {"pointsEarned": 5},
 "links": {"self": "https://learningmanager.adobe.com/primeapi/v2/users/746783/userSkills/746783_4426_1"}
 },
 "included": [
 {
 "id": "4426",
 "type": "skill",
 "attributes": {"name": "Java"},
 "links": {"self": "https://learningmanager.adobe.com/primeapi/v2/skills/4426"}
 },
 {
 "id": "4426_1",
 "type": "skillLevel",
 "attributes": {"maxCredits": 10}
 }
 ]
}

Learning Manager模型 models

Learning Manager API可讓開發人員以RESTful資源的形式存取Learning Manager物件。 每個API端點代表資源，通常是Badge之類的物件例項或這類物件的集合。 開發人員接著會使用HTTP動詞(例如PUT、GET、POST和DELETE)對這些物件（集合）執行CRUD操作。

物件屬性和關係的清單。

應用程式開發流程 registration

先決條件 prerequisites

身為開發人員，您必須在Learning Manager上建立試用帳戶，才能完整存取該帳戶內的所有角色。 為了能夠編寫應用程式，開發人員必須建立一些使用者和課程，並將帳戶置於合理狀態，以便正在開發的應用程式可以存取一些範例資料。

建立使用者端ID和密碼 createclientidandsecret

應用程式開發與測試 applicationdevelopmentandtesting

開發人員可使用Learning Manager API來建置任何應用程式。 開發人員必須確保其帳戶包含某些有效的使用者和課程。 他們可以建立一些虛擬的使用者和課程，並在試用帳戶中模擬活動，以便測試應用程式的功能。

應用程式部署 applicationdeployment

我們建議生產帳戶的Learning Manager管理員或整合管理員負責將應用程式提供給組織內的使用者。 一旦應用程式經過測試且視為已準備好生產，請通知生產帳戶的管理員。 理想情況下，管理員可以在生產帳戶中為應用程式產生新的使用者端ID和使用者端密碼，並執行必要步驟，以安全的方式將它們合併到應用程式中。 部署應用程式的實際程式因企業而異，組織的Learning Manager管理員必須從組織內的IT/IS部門取得支援，才能完成部署。

外部應用程式核准 externalapplicationapproval

您可以在​ 應用程式 ​頁面的右上角按一下​ 核准，以新增外部應用程式。 提供外部應用程式ID，然後按一下​ 儲存。

新增並核准外部應用程式

常見問題