응용 프로그램 개발자 설명서

개요 overview

Adobe Learning Manager는 클라우드 호스팅 방식의 학습자 중심 셀프서비스 학습 관리 솔루션입니다. 고객은 Learning Manager API로 Learning Manager 리소스에 프로그래밍 방식으로 액세스하여 다른 기업 응용 프로그램과 통합할 수 있습니다. Adobe 파트너 또한 기능을 확장하거나 다른 응용 프로그램 또는 서비스와 통합하여 Learning Manager의 가치 제안을 강화하는 데 API를 사용할 수 있습니다.

사용 시나리오 usagescenario

개발자는 Learning Manager API를 사용하여 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 Object Model의 주요 요소를 응용 프로그램 개발자에게 공개합니다. 개발자는 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을 가져올 수 있습니다. 브라우저에서는 SSO, Adobe ID 등 사전 구성된 계정을 이용하여 Learning Manager 사용자를 인증하는 Get URL을 사용해야 합니다.

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로 브라우저가 리디렉션됩니다. 매개 변수 코드 ​가 redirect 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:

POST https://learningmanager.adobe.com/oauth/token/refresh Content-Type: 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>

사용 제한

액세스 토큰은 7일간 유효합니다. 날짜가 지나면 새로 고침 토큰을 사용하여 새로운 액세스 토큰을 생성해야 합니다. 기존 액세스 토큰이 아직 유효한 상태에서 새로 고침 토큰을 이용하여 새로운 액세스 토큰을 생성하면, 기존 토큰은 반환됩니다.

Learning Manager에서 자주 사용되는 용어를 아래에서 참조하십시오.

포함

개발자는 단일 객체 API 모델 및 해당 모델에 관련된 여러 모델에 액세스할 수 있습니다. 관련 후속 모델에 액세스하려면 각 모델과 기타 모델과의 관계를 파악해야 합니다. 포함 매개 변수를 사용하면 개발자가 종속 모델에 액세스할 수 있습니다. 여러 모델에 액세스할 때는 쉼표를 구분 기호로 사용합니다. 샘플 사용 및 포함 ​에 대한 자세한 내용은 이 페이지의 API 모델 섹션을 참조하세요.

API 요청

HTTP 요청을 만들어 API 요청을 할 수 있습니다. 엔드 포인트와 메서드에 따라 개발자는 GET, PUT, POST, DELETE, PATCH 등 다양한 HTTP 동사를 선택할 수 있습니다. 일부 요청에 대해 쿼리 매개 변수를 전달할 수 있습니다. 특정 데이터 모델에 대해 요청을 할 때, 사용자는 JSON API 사양에 설명된 관련 모델에 대해서도 요청할 수 있습니다. 일반적인 API 요청의 구조는 샘플 모델 사용에 설명되어 있습니다.

API 응답

클라이언트가 API 요청을 하면 JSON API 사양에 따라 SON 문서를 획득합니다. 응답에는 HTTP 상태 코드도 포함되어 있습니다. 이 코드를 통해 개발자는 자신의 응용 프로그램 논리에서 적절한 다음 단계를 수행하는지 확인할 수 있습니다. 일반적인 API 응답의 구조는 샘플 모델 사용에 설명되어 있습니다.

오류

API 요청이 실패하면, 오류 응답을 획득합니다. 응답에서 반환된 HTTP 상태 코드는 오류의 원인을 표시합니다. 오류 코드는 API 참조 내의 각 모델에 대한 숫자로 표시됩니다. 200, 204, 400 및 404는 HTTP 액세스 문제를 나타내는 API에서 흔히 나타나는 오류입니다.

필드

API 객체 속성 및 그 관계는 집합적으로 필드라고 합니다. 자세한 내용은 JSON API를 참조하십시오. 모델에서 하나 이상의 특정 특성을 가져오는 API 호출 시 필드를 매개 변수로 사용할 수 있습니다. 필드 매개 변수가 없는 경우, API 호출은 모델에서 사용 가능한 모든 속성을 가져옵니다. 예를 들어 다음 API 호출에서 fields[skill]=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의 사용자 스킬 모델 ID의 기본 구성 요소는 ID, 유형, 달성 일자, 생성 일자, 획득 점수입니다. 개발자가 GET 메서드를 사용하여 사용자 스킬 모델의 세부 정보를 획득하고자 할 때, 기본 속성에 속하는 데이터가 응답 결과에 표시됩니다.

하지만, 이 시나리오에서 개발자는 사용자의 스킬 이름과 스킬 레벨의 점수를 얻고자 합니다. Learning Manager API에서는 관계 필드와 포함 매개 변수를 사용하여 관련된 정보에 액세스할 수 있습니다. 사용자 스킬에 관련된 모델은 관계 태그로 획득합니다. 사용자 스킬과 함께 해당 모델을 호출하여 각 관련 모델의 세부 정보를 얻을 수 있습니다. 이 정보를 얻으려면 각 관련 모델에 대해 점(마침표)으로 구분 값을 표시한 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

예를 들어 사용자 ID는 746783, 사용자 스킬 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 엔드 포인트는 리소스를 나타냅니다. 이는 일반적으로 배지와 같은 인스턴스 또는 해당 객체의 집합입니다. 개발자는 PUT, GET, POST 및 DELETE 등의 HTTP 동사를 사용하여 해당 객체(집합)에서 CRUD(생성, 읽기, 갱신, 삭제) 작업을 수행할 수 있습니다.

개체 특성 및 관계 목록입니다.

응용 프로그램 개발 프로세스 registration

필수 구성 요소 prerequisites

개발자는 Learning Manager 평가판 계정을 생성하여 해당 계정이 모든 역할에 대한 완전한 액세스를 갖게 해야 합니다. 응용 프로그램을 작성하려면 개발자는 일부 사용자 및 강의를 생성하고 계정을 적절한 상태로 만들어 개발 중인 응용 프로그램이 샘플 데이터에 액세스할 수 있도록 해야 합니다.

클라이언트 ID 및 시크릿 생성 createclientidandsecret

응용 프로그램 개발 및 테스트 applicationdevelopmentandtesting

개발자는 Learning Manager API를 사용하여 응용 프로그램을 만들 수 있습니다. 개발자는 자신의 계정이 유효한 사용자와 강의로 구성되어 있는지 확인해야 합니다. 개발자는 일부 더미 사용자 및 강의를 생성한 다음 평가판 계정에서 활동을 시뮬레이션하여 응용 프로그램의 기능을 테스트할 수 있습니다.

응용 프로그램 배포 applicationdeployment

Learning Manager 책임자 또는 제작 계정의 통합 책임자가 조직 내 사용자가 이용하는 응용 프로그램 제작에 대한 소유권을 갖는 것이 좋습니다. 응용 프로그램을 테스트했고 제작 준비가 되었다면 제작 계정 책임자에게 알립니다. 이상적인 경우 책임자는 제작 계정 내 응용 프로그램을 위한 새로운 클라이언트 ID와 클라이언트 시크릿을 생성하고 안전한 방식으로 응용 프로그램을 통합하는 데 필요한 단계를 수행합니다. 응용 프로그램을 배포하는 실제 절차는 기업마다 다릅니다. 조직 내 Learning Manager 책임자는 조직 내 IT/IS 부서의 도움을 받아 배포를 완료해야 합니다.

외부 응용 프로그램 승인 externalapplicationapproval

응용 프로그램 페이지의 오른쪽 상단 모서리에 있는 승인 ​을 클릭하여 외부 응용 프로그램을 추가할 수 있습니다. 외부 응용 프로그램 ID를 입력한 다음 '저장' ​을 클릭합니다.

외부 응용 프로그램 추가 및 승인

자주 묻는 질문