Handleiding voor toepassingsontwikkelaars

Overzicht overview

Adobe Learning Manager is een studentgerichte, selfservice Learning Management Solution die in de cloud wordt gehost. Klanten kunnen toegang krijgen tot Learning Manager-leermiddelen met behulp van de Learning Manager-API om deze te integreren met andere bedrijfstoepassingen. De API kan ook door Adobe-partners worden gebruikt om de waardepropositie van Learning Manager te verbeteren door de functionaliteit ervan uit te breiden of door middel van integratie met andere toepassingen of diensten.

Gebruiksscenario usagescenario

Met behulp van Learning Manager-API kunnen ontwikkelaars autonome toepassingen bouwen die de functionaliteit van Learning Manager uitbreiden of Learning Manager integreren met andere bedrijfsapplicatieworkflows. U kunt met technologie naar keuze een webtoepassing, desktopclient of mobiele app ontwikkelen. Als ontwikkelaar hebt u vanuit Learning Manager toegang tot uw toepassingsgegevens. De implementatie van de toepassing die u ontwikkelt, vindt plaats buiten het Learning Manager-platform en u hebt volledige controle over de levenscyclus van de softwareontwikkeling naarmate de toepassing zich ontwikkelt. Toepassingen worden meestal ontwikkeld door een klantorganisatie voor gebruik met hun Learning Manager-account, en deze toepassingen zijn 'privé' voor die specifieke klantorganisatie. Adobe-partners kunnen daarnaast met de Learning Manager-API generieke toepassingen bouwen die gebruikt kunnen worden door een grote groep Learning Manager-klanten.

Learning Manager-API apidescription

De Learning Manager-API is gebaseerd op de principes van REST en maakt belangrijke elementen van het Learning Manager-objectmodel beschikbaar voor ontwikkelaars van toepassingen via HTTP. Voordat ze volledig op de hoogte zijn van de API-eindpunten en HTTP-methoden kunnen ontwikkelaars eerst vertrouwd raken met de verschillende Learning Manager-objecten, hun attributen en onderlinge relaties. Nadat een inzicht in de modellen is verworven, is het handig om enige basiskennis van de structuur van API-verzoeken en -reacties op te doen, evenals van enkele gemeenschappelijke programmeertermen die we algemeen ondersteunen in de API.

Voor details van de diverse API eindpunten en methodes, verwijs naar de het Leren API documentatie van de Manager.

Student-API's

Adobe Learning Manager - Met API's voor studenten kunt u een aangepaste leerervaring voor uw gebruikers maken. Het gebruik van deze API's vereist een geldig gebruikerstoken en moet alleen worden gebruikt voor workflows waarbij een volledig gelicentieerde/geregistreerde student aanwezig is.

Voor de niet-aangemelde gebruiksscenario's is een speciale afhandeling vereist.

Bereik uit aan het team van de Architectuur van de Oplossing, voor het geval u om het even welke vragen over het aangewezen gebruik van deze APIs hebt en ervoor zorgt dat een Architect van de Oplossing een oplossing heeft onderzocht alvorens u het opstelt.

API-verificatie apiauthentication

Wanneer u een toepassing schrijft die API-oproepen naar Learning Manager verstuurd, moet u uw toepassing registreren met behulp van de integreatiebeheerder-app.

Learning Manager xAPI gebruikt OAuth 2.0 framework om uw cliëntapplicaties te verifiëren en autoriseren.

Procedure

1. Opstelling uw toepassing

U kunt uw toepassing instellen met de client-ID en het clientgeheim om de juiste eindpunten te gebruiken. Zodra u uw toepassing registreert, kunt u clientId en clientSecret krijgen. U gebruikt GET URL in uw browser omdat deze de Learning Manager-gebruikers authenticeert met behulp van hun vooraf geconfigureerde accounts zoals SSO, Adobe ID enzovoort.

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.

Na succesvolle authenticatie wordt uw browser omgeleid naar de redirect_url die in de bovenstaande URL staat vermeld. Er wordt samen met de omleidingslink een parametercode toegevoegd.

2. Ontvang vernieuwingstoken via code

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

De hoofdtekst van de berichtaanvraag:

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

3. verkrijg een toegangstoken van vernieuwingstoken

URL om toegangstoken te verkrijgen:

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

De hoofdtekst van de berichtaanvraag:

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

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

URL om de details van de toegangstoken te controleren

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

Gebruiksbeperking

Een toegangstoken is zeven dagen geldig. Na een dag moet u met behulp van een vernieuwingstoken een nieuw toegangstoken genereren. Als u met een vernieuwingstoken een nieuw toegangstoken genereert terwijl een bestaand toegangstoken nog geldig is, wordt het bestaande token geretourneerd.

Enkele van de meestgebruikte termen in Learning Manager-API worden hieronder uitgelegd, ter referentie.

Inclusief

Ontwikkelaars hebben toegang tot één API-objectmodel en ook tot meerdere modellen die bij dat model horen. Om toegang te krijgen tot de volgende gerelateerde modellen, moet u de relatie van elk model met andere modellen begrijpen. omvat parameter laat ontwikkelaars toe om tot de afhankelijke modellen toegang te hebben. U kunt een kommascheidingsteken gebruiken om toegang te krijgen tot meerdere modellen. Voor steekproefgebruik en meer details op omvat, verwijs naar de modelsectie van steekproefAPI in deze pagina.

API-verzoek

De API-verzoeken kunnen worden gedaan door een HTTP-verzoek in te dienen. Afhankelijk van het eindpunt en de methode kan de ontwikkelaar een keuze maken uit verschillende HTTP-woorden zoals GET, PUT, POST, DELETE, PATCH, enz. Voor sommige verzoeken kunnen queryparameters worden doorgegeven. Bij het aanvragen van een specifiek gegevensmodel kan de gebruiker ook een verzoek indienen voor gerelateerde modellen zoals beschreven in de JSON API-specificaties. De structuur van een typisch API-verzoek wordt beschreven in voorbeeld modelgebruik.

API-respons

Wanneer een API-verzoek wordt gedaan door een klant, wordt een SON-document verkregen volgens de JSON API-specificatie. De reactie bevat ook de HTTP-statuscode, die de ontwikkelaar kan verifiëren om de juiste volgende stappen in zijn toepassingslogica uit te voeren. De structuur van een typische API Reactie wordt beschreven in gebruik van het steekproefmodel.

Fouten

Wanneer een API-verzoek mislukt, wordt een Foutreactie verkregen. De HTTP-statuscode die in de reactie wordt teruggestuurd, geeft de aard van de fout aan. Foutcodes worden weergegeven met nummers voor elk model in de API-referentie. 200, 204, 400 en 404 zijn enkele veelvoorkomende fouten in API's die wijzen op problemen met HTTP-toegang.

Velden

De attributen van API-objecten en hun relatie worden gezamenlijk velden genoemd. Raadpleeg de JSON API voor meer informatie. U kunt Velden als parameter gebruiken terwijl u API-aanroepen doet om een of meer specifieke kenmerken van het model op te halen. Bij afwezigheid van de parameter Velden, haalt de API-aanroep alle beschikbare attributen van het model op. Bijvoorbeeld, in de volgende API vraag, haalt de gebieden [ vaardigheid ]=name u het naamattribuut van het vaardigheidsmodel alleen.

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

Paginering

Soms resulteert een API-verzoek in een lange lijst van objecten die in de reactie moeten worden geretourneerd. In dergelijke gevallen stelt het pagineringsattribuut de ontwikkelaar in staat om de resultaten achter elkaar op te halen in termen van meerdere pagina's, waarbij elke pagina een reeks records bevat. Met het pagineringsattribuut in Learning Manager kunt u bijvoorbeeld het maximale aantal records instellen dat op een pagina moet worden weergegeven. Ook kunt u het waardebereik van de records definiëren die op de pagina moeten worden weergegeven.

Sorteren

Sorteren is toegestaan in API-modellen. Kies op basis van het model het type sortering dat op de resultaten moet worden toegepast. Sorteren kan oplopend of aflopend worden toegepast. Als u bijvoorbeeld code sort=name opgeeft, wordt oplopend gesorteerd op naam. Als u code sort=-name opgeeft, wordt er aflopend gesorteerd op naam. Verwijs naar JSON API specificaties voor meer informatie.

API-gebruiksillustratie samplemodel

Laten we een scenario overwegen waarbij een ontwikkelaar vaardigheidsnaam, maximale punten voor vaardigheidsniveau en punten die de student voor die vaardigheid heeft verdiend, wil ophalen.

Een userSkill-model in Learning Manager-API's heeft id, type, dateAchieved, dateCreated en pointsEarned als standaardattributen. Dus, wanneer een ontwikkelaar de GET-methode gebruikt om details van userSkill-model te verkrijgen, worden de huidige gegevens met betrekking tot de standaardattributen getoond in de responsuitvoer.

Maar in dit scenario wil de ontwikkelaar de naam van de vaardigheid en het vaardigheidsniveau van de gebruiker weten. Learning Manager-API stelt u in staat om toegang te krijgen tot deze gerelateerde informatie met behulp van relatievelden en de parameter include. De bijbehorende modellen voor userSkill worden verkregen in relatietags. U kunt de details van elk van de bijbehorende modellen opvragen door deze modellen samen met de userSkill op te roepen. Gebruik voor deze informatie de parameter code include met door punten (punten) gescheiden waarden voor elk van de bijbehorende modellen. U kunt een komma als scheidingsteken gebruiken om een ander model aan te vragen, zoals user include=skillLevel.skill,course

API-aanroep

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 bijvoorbeeld 746783 zijn en het userSkills id: 746783_4426_1.

Reactie van API-aanroep

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

De Learning Manager-API geeft ontwikkelaars toegang tot Learning Manager-objecten als RESTful-resources. Elk API-eindpunt vertegenwoordigt een bron, meestal een object zoals een badge, of een verzameling van dergelijke objecten. De ontwikkelaars gebruiken vervolgens de HTTP-werkwoorden zoals PUT, GET, POST en DELETE om de CRUD-bewerkingen op die objecten (collecties) uit te voeren.

Lijst met objectkenmerken en -relaties.

Het ontwikkelingsproces van toepassingen registration

Vereisten prerequisites

Als ontwikkelaar moet u een proefaccount bij Learning Manager aanmaken, zodat u volledige toegang hebt tot alle rollen binnen dat account. Om een toepassing te kunnen schrijven, moet een ontwikkelaar een aantal gebruikers en cursussen aanmaken en het account in een redelijke staat brengen, zodat de toepassing in ontwikkeling toegang kan krijgen tot wat voorbeeldgegevens.

Maak client-ID en -geheim createclientidandsecret

Ontwikkeling en testen van toepassingen applicationdevelopmentandtesting

De Learning Manager-API kan door ontwikkelaars worden gebruikt om een willekeurige toepassing te bouwen. Ontwikkelaars moeten ervoor zorgen dat hun accounts bestaan uit een aantal geldige gebruikers en cursussen. Ze kunnen dummygebruikers en cursussen aanmaken en activiteiten simuleren in het proefaccount, zodat ze de functionaliteit van de toepassing kunnen testen.

Toepassingsimplementatie applicationdeployment

We raden aan dat de Learning Manager-beheerder of een integratiebeheerder voor het productieaccount de toepassing beschikbaar maakt voor gebruikers binnen hun organisatie. Zodra de toepassing is getest en klaar is voor productie, informeert u de beheerder over het productieaccount. Idealiter genereren de beheerders een nieuw client-ID en clientgeheim voor de toepassing in het productie-account en voeren ze de nodige stappen uit om deze op een veilige manier in de toepassing te integreren. De eigenlijke procedure voor de implementatie van toepassingen varieert van onderneming tot onderneming en de Learning Manager-beheerder van uw organisatie moet ondersteuning krijgen van de IT/IS-afdeling binnen uw organisatie om de implementatie te voltooien.

Externe goedkeuring van de toepassing externalapplicationapproval

U kunt externe toepassingen toevoegen door te klikken keurt in de hoger-juiste hoek van de pagina van Toepassingen goed. Geef de externe toepassings-ID op en klik op Opslaan.

voeg en keur een externe toepassing toe

Veelgestelde vragen