Adobe Captivate Prime is een studentgerichte, selfservice Learning Management Solution die in de cloud wordt gehost. De Prime API biedt toegang tot leermiddelen die beschikbaar zijn op Prime voor programmatische toegang. Hierdoor kunnen klanten Prime uitbreiden en met andere gebruikte bedrijfstoepassingen integreren om naadloze workflows te implementeren. De API kan ook worden gebruikt door Adobe-partners om de waardepropositie van Prime te verbeteren door de functionaliteit ervan uit te breiden of door middel van integraties met populaire toepassingen of diensten.
De Prime API is gebaseerd op de architectuurprincipes van REST en maakt belangrijke elementen van het Prime-objectmodel, zoals Gebruiker, Cursus, Leerplan en Inschrijving als leermiddelen beschikbaar. Alle API-verzoeken worden gedaan in de context van een specifieke gebruiker die is geverifieerd voor toegang tot een specifieke Prime-account. Hierdoor heeft de gebruiker alleen toegang tot de gegevens binnen dat account, en ook dat wordt bepaald door de rollen en machtigingen van de gebruiker.
In versie 1 is de Prime-API vooral gericht op het bieden van GET-toegang tot de meeste leermiddelen. Raadpleeg de API-documentatie voor een uitgebreide en volledige lijst van de eindpunten en methoden. Prime heeft een zeer rijk datamodel met meerdere objecttypes (resources) en onderlinge relaties. Daarom hebben we ervoor gekozen om de JSONAPI v1.0-specificatie te volgen waarmee side-loading- en API-reacties polymorf kunnen worden gemaakt.
Met behulp van de Prime-API kunnen ontwikkelaars autonome toepassingen bouwen die de functionaliteit van Prime uitbreiden of Prime zelfs integreren in de context van specifieke workflows met andere bedrijfsapplicaties. De toepassing die u ontwikkelt wordt meestal buiten het Prime-platform geïmplementeerd (deze kan een webtoepassing, desktoptoepassing of mobiele toepassing zijn) en de ontwikkelaar heeft volledige controle over het beheer van die toepassing gedurende de levenscyclus. Toepassingen worden meestal ontwikkeld door een klantorganisatie voor gebruik met hun Prime-account, en deze toepassingen zijn 'privé' voor die specifieke klantorganisatie. Adobe-partners mogen de Prime-API echter ook gebruiken om algemene toepassingen te bouwen die van 'gemeenschappelijk' belang kunnen zijn voor een grote groep Prime-klanten.
De volgende sectie geeft een snel overzicht op hoog niveau van de Prime-API en doorloopt de code van een voorbeeldtoepassing. De rest van dit document richt zich erop hoe ontwikkelaars de sleutels voor hun toepassingen kunnen verkrijgen en beheren, en hoe toepassingen worden vertrouwd voor gebruik door Prime-accounts. Raadpleeg de API-documentatie voor meer informatie over de verschillende API-eindpunten en -methoden.
Prime-API
De Prime-API is gebaseerd op de principes van REST en maakt belangrijke elementen van het Prime-objectmodel beschikbaar voor ontwikkelaars van toepassingen via HTTP. Voordat we op de details van de API-eindpunten en HTTP-methoden ingaan, is het voor ontwikkelaars misschien nuttig om zich eerst vertrouwd te maken met de verschillende Prime-objecten, hun attributen en onderlinge relaties. Nadat een goed 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 programmeerbegrippen die we algemeen ondersteunen in de API. Aan het einde van de sectie doorlopen we de code van een eenvoudig voorbeeld.
Prime-modellen
De Prime-API geeft ontwikkelaars toegang tot Prime-objecten als RESTful-resources. Dit betekent in wezen dat elk API-eindpunt een resource vertegenwoordigt (meestal een object zoals 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.
De volgende tabel geeft een overzicht van de verschillende elementen van het Prime-objectmodel
Proces voor toepassingsontwikkeling
Ontwikkelen en testen
Zet een dev-account op
We raden de ontwikkelaar aan eerst een proefaccount op Prime te maken, zodat deze volledige toegang heeft tot alle rollen binnen dat account. Om een toepassing te kunnen schrijven, moet de ontwikkelaar ook enkele gebruikers en cursussen maken en het account in een redelijke staat brengen, zodat de toepassing in ontwikkeling toegang heeft tot wat dummygegevens
Maak client-ID en -geheim
Leg uit hoe naar de rol van Integratiebeheerder overstapt en een nieuwe toepassing registreert. Laat screenshot zien en leg verschillende velden uit
Ontwikkel en test de toepassing
De Prime-API kan door de ontwikkelaar worden gebruikt om een willekeurige toepassing te bouwen. Tijdens de ontwikkeling moet de ontwikkelaar ervoor zorgen dat het proefaccount enkele gebruikers en cursussen heeft. Het is beter voor de ontwikkelaar om ten minste een paar dummygebruikers en -cursussen op te zetten en activiteit in het proefaccount simuleren om de functionaliteit van de toepassing te testen.
