Användarhandbok för programutvecklare

Översikt overview

Adobe Learning Manager är en molnbaserad, elevcentrerad och självbetjänad lösning för hantering av inlärning. Kunder kan använda Learning Manager-resurser programmatiskt med Learning Manager-API:et för att integrera det med andra företagsprogram. API kan också användas av Adobe partners för att förbättra värdepåståendet i Learning Manager genom att utöka dess funktionalitet eller genom att integrera den med andra program eller tjänster.

Användningsscenario usagescenario

Med Learning Manager API kan utvecklare skapa fristående program som utökar funktionerna i Learning Manager eller integrerar Learning Manager med andra arbetsflöden för företagsprogram. Du kan utveckla ett webbprogram, en datorklient eller en mobilapp med valfri teknik. Som utvecklare kan du komma åt dina programdata från Learning Manager. Driftsättningen av programmet som du utvecklar är extern till Learning Manager-plattformen och du har full kontroll över programutvecklingslivscykeln allt eftersom programmet utvecklas. Vanligtvis utvecklas program av en kundorganisation för användning med deras Learning Manager-konto, och dessa program är privata för den specifika kundorganisationen. Adobe-partners kan också skapa generiska program med Learning Manager API som kan användas av en stor mängd Learning Manager-kunder.

API för Learning Manager apidescription

Learning Manager API baseras på REST-principer och visar viktiga element i Learning Manager-objektmodellen för programutvecklare via HTTP. Innan du känner till detaljerna för API-slutpunkterna och HTTP-metoderna kan utvecklare bekanta sig med de olika Learning Manager-objekten, deras attribut och inbördes relationer. När modellerna har förståtts är det bra att ha en grundläggande förståelse för strukturen hos API-begäranden och -svar, och några vanliga programmeringstermer som vi använder generellt i hela API:et.

Mer information om de olika API-slutpunkterna och -metoderna finns i dokumentationen för Learning Manager API.

Elevens API

Adobe Learning Manager - Med elev-API:er kan du skapa en anpassad utbildningsupplevelse för dina användare. Användningen av dessa API:er kräver en giltig användartoken och ska bara användas i arbetsflöden där det finns en helt licensierad/registrerad elev.

De användningsfall som inte är inloggade kräver särskild hantering.

Kontakta lösningsarkitekturteamet om du har frågor om lämplig användning av dessa API:er och se till att en lösningsarkitekt har testat en lösning innan du driftsätter den.

API-autentisering apiauthentication

När du skriver ett program som gör API-anrop till Learning Manager måste du registrera programmet med hjälp av appen Integration Admin.

Learning Manager API:er använder OAuth 2.0 Framework för att autentisera och auktorisera dina klientprogram.

Procedur

1. Konfigurera ditt program

Du kan konfigurera programmet med klient-ID och klienthemlighet och använda rätt slutpunkter. När du har registrerat programmet kan du hämta clientId och clientSecret. Get URL bör användas i webbläsare eftersom det autentiserar Learning Manager-användare med deras förkonfigurerade konton som SSO, Adobe ID och så vidare.

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.

När autentiseringen är klar omdirigeras webbläsaren till den redirect_uri som nämns i ovanstående URL. En parameter kod läggs till tillsammans med omdirigerings-URI:n.

2. Hämta uppdateringstoken från koden

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

Brödtext för begäran om inlägg:

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

3. Hämta en åtkomsttoken från uppdateringstoken

URL för att hämta åtkomsttoken:

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

Brödtext för begäran om inlägg:

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

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

URL för verifiering av information om åtkomsttoken

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

Användningsbegränsning

En åtkomsttoken är giltig i sju dagar. Efter en dag måste du generera en ny åtkomsttoken med uppdateringstoken. Om du genererar en ny åtkomsttoken från uppdateringstoken medan en befintlig åtkomsttoken fortfarande är giltig, returneras den befintliga token.

Några av de vanligaste termerna i Learning Manager API förklaras nedan som referens.

Inkluderar

Utvecklare kan komma åt en enda API-objektmodell och flera modeller som är kopplade till den modellen. Om du vill komma åt efterföljande relaterade modeller måste du förstå förhållandet mellan varje modell och andra modeller. Parametern Includes gör att utvecklare kan komma åt beroende modeller. Du kan använda kommaavgränsare för att komma åt flera modeller. Mer information om exempelanvändning och inkluderar finns i avsnittet om exempel på API-modell på den här sidan.

API-begäran

API-begäranden kan göras genom att göra en HTTP-begäran. Beroende på ändpunkt och metod utvecklare kan ha ett val av olika HTTP verb såsom GET, PUT, POST, DELETE, PATCH, etc. För vissa förfrågningar kan frågeparametrar skickas. När en begäran om en specifik datamodell görs kan användaren också begära relaterade modeller enligt beskrivningen i JSON API-specifikationerna. Strukturen för en typisk API-begäran beskrivs i exempelmodellanvändning.

API-svar

När en API-begäran görs av en klient hämtas ett SON-dokument enligt JSON API-specifikationen. Svaret innehåller också HTTP-statuskoden, som utvecklaren kan verifiera för att utföra nästa steg i sin programlogik. Strukturen för ett typiskt API-svar beskrivs i exempelmodellanvändning.

Fel

När en API-begäran misslyckas får du ett felsvar. Den HTTP-statuskod som returneras i svaret anger felets art. Felkoder visas med siffror för varje modell i API-referensen. 200, 204, 400 och 404 är några av de vanliga felen som representeras i API:er som indikerar HTTP-åtkomstproblem.

Fält

API-objektets attribut och relationer kallas gemensamt för fält. Se JSON API för mer information. Du kan använda Fält som en parameter när du gör API-anrop för att hämta ett eller flera specifika attribut från modellen. I avsaknad av parametern Fields hämtar API-anropet alla tillgängliga attribut från modellen. I följande API-anrop hämtar till exempel fälten [skills]=name attributet name för enbart kompetensmodellen.

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

Sidnumrering

Ibland resulterar en API-begäran i en lång lista med objekt som ska returneras i svaret. I sådana fall gör attributet paginering att utvecklaren kan hämta resultaten sekventiellt i form av flera sidor, där varje sida innehåller ett intervall av poster. Med pagineringsattributet i Learning Manager kan du till exempel ange det maximala antalet poster som ska visas på en sida. Du kan också definiera intervallvärden för posterna som ska visas på sidan.

Sortering

Sortering är tillåtet i API-modeller. Välj vilken typ av sortering som ska användas för resultaten baserat på modellen. Sortering kan göras i stigande eller fallande ordning. Om du till exempel anger code sort=name, sorteras den stigande efter namn. Om du anger code sort=-name sorteras den fallande efter namn. Se JSON API-specifikation om du vill ha mer information.

Illustration av API-användning samplemodel

Låt oss överväga ett scenario där en utvecklare vill få ett färdighetsnamn, maxpoäng tilldelade för färdighetsnivå och poäng som eleven fått för denna färdighet.

En userSkill-modell i API:er för Learning Manager består av id, type, dateAchived, dateCreated och pointsEarned som standardattribut. När en utvecklare använder GET-metoden för att hämta information om userSkill-modellen visas aktuella data som gäller standardattributen i svarsutdata.

Men i det här scenariot vill utvecklaren få färdighetsnamnet och kunskapspoängen för användaren. Med Learning Manager API kan du komma åt denna relaterade information med hjälp av relationsfält och inkludera parametrar. De associerade modellerna för userSkill hämtas i relationstaggen. Du kan få information om varje associerad modell genom att anropa dessa modeller tillsammans med userSkill. Om du vill hämta den här informationen använder du parametern code include med punkt- (punkt) separerade värden för var och en av de associerade modellerna. Du kan använda kommatecken som avgränsare för att begära en annan modell som user include=skillsLevel.skills,course

API-anrop

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 kan till exempel 746783 och userSkills id: 746783_4426_1.

Svar från API-anrop

\{
 "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-modeller models

Med Learning Manager API kan utvecklare få tillgång till Learning Manager-objekt som RESTful-resurser. Varje API-slutpunkt representerar en resurs, vanligtvis en objektinstans som Badge, eller en samling av sådana objekt. Utvecklarna använder sedan HTTP-verb som PUT, GET, POST och DELETE för att utföra CRUD-åtgärder på dessa objekt (samlingar).

Lista över objektattribut och relationer.

Programutvecklingsprocess registration

Krav prerequisites

Som utvecklare måste du skapa ett testkonto i Learning Manager, så att du har full tillgång till alla roller i kontot. För att kunna skriva ett program måste utvecklaren skapa vissa användare och kurser och få kontot i rimligt skick så att programmet som utvecklas kan få tillgång till vissa exempeldata.

Skapa klient-ID och hemlighet createclientidandsecret

Programutveckling och testning applicationdevelopmentandtesting

Utvecklare kan använda Learning Manager API för att skapa valfria program. Utvecklare måste se till att deras konton består av vissa giltiga användare och kurser. De kan skapa några dummyanvändare och kurser och simulera aktivitet i testkontot, så att de kan testa programmets funktion.

Programdistribution applicationdeployment

Vi rekommenderar att Learning Manager-administratören eller en integrationsadministratör för produktionskontot ser till att göra programmet tillgängligt för användare i organisationen. När ansökan har testats och anses redo för produktion, informera administratören för produktionskontot. Helst vill administratörerna generera ett nytt klient-ID och en klienthemlighet för programmet i produktionskontot och utföra de steg som krävs för att införliva dem i programmet på ett säkert sätt. Den faktiska proceduren för att driftsätta program varierar från företag till företag och organisationens Learning Manager-administratör måste ta emot support från IT/IS-avdelningen i organisationen för att slutföra driftsättningen.

Godkännande av externt program externalapplicationapproval

Du kan lägga till externa program genom att klicka på Godkänn i det övre högra hörnet på sidan Program. Ange det externa program-id:t och klicka på Spara.

Lägg till och godkänn ett externt program

Vanliga frågor