Overzicht

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

Gebruiksscenario

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

Captivate Prime-API

De Captivate Prime-API is gebaseerd op de principes van REST en maakt belangrijke elementen van het Captivate Prime-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 Captivate Prime-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.

Raadpleeg de Captivate Prime API-documentatie voor meer informatie over de verschillende Captivate Prime API-eindpunten en -methoden.

API-verificatie

Wanneer u een toepassing schrijft die API-aanroepen naar Prime doet, moet u uw toepassing registreren met behulp van de integratiebeheerder-app. 

Captivate Prime-API’s gebruiken het OAuth 2.0-framework om uw clienttoepassingen te authenticeren en autoriseren. 

Procedure

1. Stel uw toepassing in 

U kunt uw toepassing instellen met de client-ID en het clientgeheim om de juiste eindpunten te gebruiken. Nadat u uw aanvraag hebt geregistreerd, kunt u de clientId en het clientSecret ophalen. U gebruikt GET URL in uw browser omdat deze de Captivate Prime-gebruikers authenticeert met behulp van hun vooraf geconfigureerde accounts zoals SSO, Adobe ID,. 

GET https://captivateprime.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://captivateprime.adobe.com/oauth/token Inhoudstype: 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>

3. Ontvang een toegangstoken via vernieuwingstoken

URL om toegangstoken te ontvangen: 

POST https://captivateprime.adobe.com/oauth/token/refresh Inhoudstype: application/x-www-form-urlencoded

De hoofdtekst van de berichtaanvraag:

client_id:<Enter your clientId>&
client_secret:<Enter your clientSecret>&
refresh_token:<refresh token>

URL om de details van de toegangstoken te controleren

GET https://captivateprime.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 Captivate Prime-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. De parameter Inclusief stelt ontwikkelaars in staat om toegang te krijgen tot de afhankelijke modellen. U kunt kommascheiding gebruiken om toegang te krijgen tot meerdere modellen. Raadpleeg voor voorbeeldgebruik en meer details over Inclusief de voorbeeld-API op 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 respons bevat ook de HTTP-statuscode, die de ontwikkelaar kan controleren om de juiste volgende stappen in zijn toepassingslogica uit te voeren.De structuur van een typische API-respons wordt beschreven in voorbeeld modelgebruik.

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 een paar van de meest voorkomende fouten in API's die wijzen op HTTP-toegangsproblemen.  

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 attributen 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-aanroep haalt veld[skill]=name in de volgende API-aanroep alleen het naamkenmerk van het vaardigheidsmodel voor u op. 

https://captivateprime.adobe.com/primeapi/v1/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 Captivate Prime 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 voor de resultaten moet worden toegepast. Sorteren kan in oplopende of aflopende volgorde worden toegepast. Als u bijvoorbeeld sort=name opgeeft, dan wordt er in oplopende volgorde gerangschikt op naam. Als u sort=-nameopgeeft, dan wordt er in aflopende volgorde gerangschikt op naam. Raadpleeg de JSON API-specificaties voor meer informatie

API-gebruiksillustratie

Laten we ons een scenario voorstellen waarin een ontwikkelaar de naam van de vaardigheid, het maximale aantal punten voor het vaardigheidsniveau en de door de student verdiende punten voor die vaardigheid wil definiëren.

Een userSkill-model in Captivate Prime-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. Captivate Prime-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 om deze informatie te verkrijgen de parameter include met waarden die door een punt gescheiden worden 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://captivateprime.adobe.com/primeapi/v1/users/{userId}/userSkills/{id}?include=skillLevel.skill&fields[skill]=name&fields[skillLevel]=maxCredits&fields[userSkill]=pointsEarned

UserId kan bijvoorbeeld 746783 zijn en het userSkills id: 746783_4426_1. 

Reactie van API-aanroep

{
   "links": {"self": "https://captivateprime.adobe.com/primeapi/v1/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://captivateprime.adobe.com/primeapi/v1/users/746783/userSkills/746783_4426_1"}
   },
   "included":    [
            {
         "id": "4426",
         "type": "skill",
         "attributes": {"name": "Java"},
         "links": {"self": "https://captivateprime.adobe.com/primeapi/v1/skills/4426"}
      },
            {
         "id": "4426_1",
         "type": "skillLevel",
         "attributes": {"maxCredits": 10}
      }
   ]
}

Captivate Prime-modellen

De Captivate Prime-API geeft ontwikkelaars toegang tot Captivate Prime-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.

Het volgende diagram geeft de verschillende elementen van het Captivate Prime-objectmodel in V1 API weer.

V1 API-objectmodel
V1 API-objectmodel

In de volgende tabel worden verschillende elementen van het Captivate Prime V1-objectmodel beschreven: 

Serienummer

Captivate Prime-object

Beschrijving

1.      

gebruiker

Gebruiker is het belangrijkste model in Captivate Prime. Gebruikers zijn meestal de interne of externe studenten van een organisatie die leerobjecten gebruiken. Zij kunnen echter ook een andere rol spelen, zoals auteur en manager, naast de rol van de student. Gebruikers-ID, -type en -e-mail zijn enkele van de inline attributen. 

2.      

course

Cursus is een van de leerobjecten die in Captivate Prime wordt ondersteund en bestaat uit een of meer modules. 

3.      

module

Module is een bouwsteen om leerobjecten te maken in Captivate Prime. De modules kunnen bestaan uit vier verschillende soorten modules, zoals klassikaal, virtueel klassikaal, activiteit en op eigen tempo. Gebruik dit modulemodel om de details van alle modules in een account te krijgen. 

4.      

certification

De certificering wordt toegekend aan studenten op basis van het succesvol afronden van een cursus. Voordat u gebruik kunt maken van certificeringen moeten in de toepassing cursussen worden aangemaakt. 

5.      

learning program

Leerprogramma's zijn uniek ontworpen cursussen die voldoen aan de specifieke leerbehoeften van gebruikers. Gewoonlijk worden de leerprogramma's gebruikt om leerdoelen die zich over de individuele cursussen uitstrekken, aan te sturen. 

6.      

badge

Een badge is een vorm van prestatiebeloning die studenten krijgen als ze specifieke mijlpalen bereiken. 

7.      

skill

Het vaardighedenmodel bestaat uit niveaus en punten. Vaardigheden kunnen door de studenten worden verworven na het afronden van de cursus. 

8.      

certificationEnrollment

Dit model geeft details over een inschrijving door een gebruiker voor één enkele certificering.

9.  

courseEnrollment

Dit model geeft details over een inschrijving door een gebruiker voor één enkele cursus. 

10.  

courseInstance

Aan een cursus kunnen één of meerdere instanties verbonden zijn. U kunt een cursusinstantie krijgen 

11.  

courseSkill

Een courseSkill-model specificeert de voortgang van afzonderlijke vaardigheden die worden bereikt door het voltooien van een cursus.

12.  

courseModule

Een courseModule-model specificeert hoe een module wordt opgenomen  in een cursus. Bijvoorbeeld, of de module wordt gebruikt als test vooraf of enkel voor de inhoud.

13.  

learningProgramInstance

Een leerprogramma kan bestaan uit meerdere instanties die soortgelijke eigenschappen van een leerprogramma of aangepaste instanties bevatten. 

14.  

job aid

Een taakhulp is een leerinhoud die toegankelijk is voor studenten zonder inschrijvings- of afrondingscriteria. U kunt informatie ophalen, zoals bijgewerkte datum, status, ID-informatie samen met de bijbehorende modellen, zoals de versie van de taakhulp, de auteurs en het vaardigheidsniveau. 

15.  

jobAidVersion

Een taakhulp kan één of meerdere daaraan gekoppelde versies hebben, gebaseerd op nummerherzieningen in inhoud en aantal uploads. Dit model geeft details over één enkele taakhulpversie. 

16.  

learningProgramInstanceEnrollment

Het leerprogramma bestaat uit één of meerdere instanties. Studenten kunnen zichzelf inschrijven voor een leerprogramma of krijgen deze toegewezen door de beheerder. Dit model geeft details over een inschrijving door een gebruiker voor één leerprogramma. 

17.  

moduleVersion

Een module kan één of meerdere versies hebben op basis van de uploads van herziene inhoud. Gebruik dit model om specifieke informatie te verkrijgen over elke afzonderlijke moduleversie. 

18.  

skillLevel

Een vaardigheidsniveau bestaat uit één of meer cursussen die moeten worden gevolgd om een niveau te bereiken met de bijbehorende punten. 

19.  

userBadge

Gebruikersbadge koppelt afzonderlijke badges aan afzonderlijke gebruikers. Het bevat details zoals wanneer de het is verdiend, assertionUrl etc. 

20.  

userSkill

UserSkill geeft de mate aan waarin een afzonderlijk vaardigheidsniveau door een afzonderlijke gebruiker wordt bereikt.

Hieronder volgen de verschillende elementen van het Captivate Prime-klasdiagram in V2 API.

V2 API-klasdiagram
V2 API-klasdiagram
Captivate Prime-object Beschrijving
account Account omvat de gegevens van een belangrijke klant.
badge Een badge is een vorm van prestatiebeloning die studenten krijgen als ze specifieke mijlpalen bereiken als ze binnen een cursus bepaalde mijlpalen bereiken. 
catalog Een catalogus is een verzameling leerobjecten.
gebruiker Gebruiker is het belangrijkste model in Captivate Prime. Gebruikers zijn meestal de interne of externe studenten van een organisatie die leerobjecten gebruiken. Zij kunnen echter naast de rol van de student een andere rol op zich nemen, zoals auteur en manager. Gebruikers-ID, -type en -e-mail zijn enkele van de inline attributen. 
resource Leermiddel wordt gebruikt voor het modelleren van elke inhoudsbron die voor een module moet worden geordend. Alle leermiddelen geordend ineen loResourcezijn gelijkwaardig in termen van het leerdoel, maar ze verschillen van elkaar in termen van het type levering of de taalinstelling van de inhoud.
userNotification Dit model bevat kennisgevingsinformatie over een student.
userSkill UserSkill geeft de mate aan waarin een afzonderlijk vaardigheidsniveau door een afzonderlijke gebruiker wordt bereikt.
userBadge UserBadge koppelt een afzonderlijke badgemeteen afzonderlijke gebruiker. Hij bevat details zoals wanneer hij is verdiend,assertionUrlen dergelijke. 
skill Het vaardighedenmodel bestaat uit niveaus en punten. Vaardigheden kunnen door de studenten worden verworven na het afronden van de cursus. 
skillLevel Een vaardigheidsniveau bestaat uit een of meer cursussen die moeten worden gevolgd om een niveau te bereiken met de bijbehorende punten. 
learningObject Een leerobject is een abstractie voor verschillende soorten objecten waar gebruikers zich voor kunnen inschrijven en van kunnen leren. Op dit moment heeft Prime vier soorten leerobjecten: Cursus, Certificering, LeerprogrammaenTaakhulp.
learningObjectInstance
Een specifieke instantie van een leerobject.
learningObjectResource Dit komt overeen met het begripmodule. Een cursus is samengesteld uit éénovermeerdere modules. In Prime kan een module op verschillende gelijkwaardige manieren worden geleverd. Daarom omvat deloResourcein wezen al die gelijkwaardige middelen.
loResourceGrade
Dit vat het resultaat samen van de gebruiker die een specifieke bron gebruikt in de context van een leerobject waarvoor hij/zij is ingeschreven. Het bevat informatie zoals de duur die eengebruikerin het leermiddel doorgebracht heeft, de procentuele vooruitgang die de gebruiker heeft geboekt, de status die hij of zij heeft behaald en de score die de gebruiker in een eventuele quiz heeft behaald.
calendar
Een kalenderobject is een lijst metaankomende klassikaleof virtuele klassikale cursussen waar de gebruiker zich voor kan inschrijven.
l1FeedbackInfo
L1-Feedback omvat de antwoorden van een student op de feedbackvragen die betrekking hebben op leerobjecten. Meestal wordt dit verzameld nadat de gebruiker een leerobject heeft voltooid, indien dit zo geconfigureerd is dat dergelijke feedback van de studenten wordt verzameld.
enrollment
Deze abstractie omvat de details met betrekking tot de transactie die de toewijzing van een specifieke gebruiker aan een specifieke leerobjectinstantie weergeeft.

Het ontwikkelingsproces van toepassingen

Vereisten

Als ontwikkelaar moet u een proefaccount op Prime 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

  1. Klik in het aanmeldvenster van de Integratiebeheerder op Toepassingen in het linkerdeelvenster.

    application-development-menu
  2. Klik op Registreren in de rechterbovenhoek van de pagina om uw toepassingsdetails te registreren. De registratiepagina verschijnt. 

    Een nieuwe aanvrager registreren
    Een nieuwe aanvrager registreren

    Het is verplicht om alle velden op deze pagina in te vullen. 

    Naam van de toepassing: voer uw aanvraagnaam in. Het is niet verplicht om dezelfde toepassingsnaam te gebruiken; een andere geldige naam is ook toegestaan. 

    URL: als u de exacte URL weet waar de toepassing gehost wordt, kunt u deze vermelden. Als u die niet weet, kunt u de URL van uw bedrijf vermelden. Een geldige URL-naam is verplicht in dit veld. 

    Doorstuurdomeinen: voer de domeinnaam in van de toepassing waarnaar u de Captivate Prime-toepassing na de OAuth-authenticatie wilt omleiden. U kunt hier meerdere URL's vermelden, maar u moet wel geldige URL's gebruiken zoals http://google.com, http://yahoo.com en dergelijke. 

    Beschrijving: vul een korte beschrijving voor uw aanvraag in. 

    Bereik: kies een van de vier beschikbare opties om het bereik van uw toepassing te definiëren. Op basis van uw hier vermelde keuze zijn Captivate Prime-API-eindpunten toegankelijk voor uw toepassing. Als u bijvoorbeeld leestoegang voor de studentrol kiest, staan alle API-eindpunten van Captivate Prime voor de student op alleen-lezen voor uw toepassing. 

    Alleen voor dit account? 
    Ja - als u Ja kiest, dan is de toepassing niet zichtbaar voor andere accountbeheerders.
    Nee - als u Nee kiest, kunnen andere accountbeheerders ook toegang krijgen tot deze toepassing, maar ze moeten de toepassings-ID gebruiken om toegang te krijgen tot deze toepassing. De toepassings-ID wordt gegenereerd en weergegeven in de modus Bewerken in de Captivate Prime-toepassing. 

    Opmerking:

    Als u kiest voor lees- en schrijftoegang voor de beheerdersrol als bereik tijdens de registratie van de toepassing en voor leestoegang voor de beheerdersrol tijdens het schrijven van de API's, dan kunt u nog steeds schrijftoegang voor de toepassing hebben, aangezien het registratiebereik van de app voorrang heeft op de autorisatieworkflow. 

  3. Klik na het invullen van de gegevens op de registratiepagina op Registreren in de rechterbovenhoek.

Ontwikkeling en testen van toepassingen

De Captivate Prime-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

We raden aan dat de Captivate Prime-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 Captivate Prime-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

U kunt externe toepassingen toevoegen door op Goedkeuren te klikken in de rechterbovenhoek van de pagina Toepassingen. Geef de externe toepassings-ID op en klik op Opslaan.

Een externe toepassing toevoegen
Een externe toepassing toevoegen

Dit werk is gelicentieerd onder de Creative Commons Naamsvermelding/Niet-commercieel/Gelijk delen 3.0 Unported-licentie  De voorwaarden van Creative Commons zijn niet van toepassing op Twitter™- en Facebook-berichten.

Juridische kennisgevingen   |   Online privacybeleid