Handbuch f�r Anwendungsentwickler

Adobe Captivate Prime ist eine in der Cloud gehostete, auf die Kursteilnehmer zugeschnittene Selfservice-L�sung f�r Learning Management. Die Prime-API gibt Zugriff auf Ressourcen, die in Prime den Programmzugriff erm�glichen. Kunden k�nnen dadurch Prime erweitern und mit anderen von ihnen verwendeten Unternehmensanwendungen integrieren, um nahtlose Arbeitsabl�ufe zu implementieren. Die API kann auch von Adobes Partnern verwendet werden und den Wertbeitrag von Prime steigern, entweder durch Erweitern von dessen Funktionsumfang oder durch Integration mit g�ngigen Anwendungen oder Diensten.

Die Architektur der Prime-API basiert auf den Prinzipien von REST und stellt wichtige Elemente des Objektmodells von Prime als Ressourcen bereit, z.�B. Benutzer, Kurs, Lernplan und Registrierung. Alle API-Anfragen erfolgen im Kontext eines bestimmten Benutzers, der f�r den Zugriff auf ein bestimmtes Prime-Konto authentifiziert wurde. Der Benutzer kann daher nur auf die Daten in diesem Konto zugreifen. Der Zugriff ist au�erdem von den Rollen und Berechtigungen des Benutzers abh�ngig.

In Version 1 der Prime-API liegt der Schwerpunkt haupts�chlich auf der Bereitstellung des GET-Zugriffs auf die meisten Ressourcen. Eine ausf�hrliche und vollst�ndige Liste der Endpunkte und Methoden finden Sie in der Dokumentation zur API. Prime bietet ein sehr reichhaltiges Datenmodell mit mehreren Objekttypen (Ressourcen) sowie Beziehungen zwischen diesen. Aus diesem Grund haben wir uns entschieden, der JSONAPI v1.0-Spezifikation zu folgen, in der Side-Loading und API-Antworten polymorph sein k�nnen.

Mithilfe der Prime-API k�nnen Entwickler eigenst�ndige Anwendungen herstellen, die den Funktionsumfang von Prime erweitern oder auch Prime in den Kontext spezifischer Arbeitsabl�ufe integrieren, in denen auch andere Unternehmensanwendungen zum Einsatz kommen. Die von Ihnen entwickelte Anwendung wird �blicherweise au�erhalb der Prime-Plattform bereitgestellt (z.�B. als Web-, Desktop- oder Mobilanwendung) und der Entwickler hat w�hrend des gesamten Lebenszyklus der Anwendung uneingeschr�nkte Kontrolle �ber deren Verwaltung. Anwendungen werden �blicherweise im Unternehmen des Kunden zur Verwendung mit dessen Prime-Konto entwickelt und diese Anwendungen sind ?privat?, d.�h. nur f�r dieses Kundenunternehmen verf�gbar. Adobe-Partner k�nnen jedoch mithilfe der Prime-API auch allgemeine Anwendungen entwickeln, die f�r eine gro�e Zahl von Prime-Kunden von gemeinsamem Interesse sein k�nnten.

Im n�chsten Abschnitt geben wir eine kurze zusammenfassende �bersicht �ber die Prime-API und stellen den Code einer Beispielanwendung vor. Im �brigen Dokument wird das Verfahren beschrieben, mit dem Entwickler die Schl�ssel f�r ihre Anwendungen abrufen und verwalten k�nnen und wie die Vertrauenseinstellungen f�r die Anwendungen zur Verwendung durch Prime-Konten gesteuert werden. Details zu den verschiedenen API-Endpunkten und -Methoden finden Sie in der Dokumentation zu der API.

Prime-API

Die Prime-API basiert auf den Prinzipien von REST und stellt wichtige Elemente des Objektmodells von Prime �ber HTTP f�r Anwendungsentwickler bereit. Entwickler sollten sich eventuell zuerst mit den verschiedenen Objekten von Prime sowie deren Attributen und Beziehungen vertraut machen, bevor sie sich mit den Detailinformationen zu den API-Endpunkten und HTTP-Methoden befassen. Nachdem ein zuverl�ssiges Verst�ndnis der Modelle vorhanden ist, empfiehlt es sich, Grundkenntnisse der Struktur von API-Anfragen und -Antworten zu erwerben und einige h�ufig vorkommende Programm-Idiome zu erlernen, die in der gesamten API allgemein unterst�tzt werden.� Der Abschnitt wird mit der Erl�uterung des Codes eines einfachen Beispiels abgeschlossen.

Prime-Modelle

In der Prime-API k�nnen Entwickler auf Prime-Objekte als RESTful-Ressourcen zugreifen. Dies bedeutet im Wesentlichen, dass jeder API-Endpunkt eine Ressource darstellt (typischerweise eine Instanz eines Objekts, etwa ein Abzeichen, oder eine Gruppe solcher Objekte). Die Entwickler k�nnen dann mithilfe von HTTP-Verben wie PUT, GET, POST und DELETE die CRUD-Operationen f�r diese Objekte bzw. Gruppen durchf�hren.

Die folgende Tabelle zeigt die verschiedenen Elemente des Prime-Objektmodells

Anwendungsentwicklungsprozess

Entwicklung und Tests

Dev-Konto abrufen

Wir empfehlen, dass der Entwickler zun�chst ein Testkonto auf Prime erstellt, um uneingeschr�nkten Zugriff auf alle Rollen in diesem Konto zu erhalten. Um eine Anwendung entwickeln zu k�nnen, muss der Entwickler au�erdem einige Benutzer und Kurse erstellen und das Konto in einen funktionsf�higen Zustand versetzen, damit Dummy-Daten vorhanden sind, auf die die zu entwickelnde Anwendung zugreifen kann.

Client-ID und Secret

Erkl�rung, wie Sie zur Integrations-Adminrolle wechseln und eine neue Anwendung anmelden k�nnen. Screenshot anzeigen und die verschiedenen Felder erkl�ren

Anwendungsentwicklung und -tests durchf�hren

Mithilfe der Prime-API k�nnen Entwickler beliebige Arten von Anwendungen erstellen. W�hrend der Entwicklung muss der Entwickler daf�r sorgen, dass im Testkonto einige Benutzer und Kurse vorhanden sind. Es empfiehlt sich f�r den Entwickler, zumindest einige Dummy-Benutzer und -Kurse zu erstellen und Aktivit�ten im Testkonto zu simulieren, um die Funktionsf�higkeit der Anwendung zu testen.