Dieser Artikel ist auch verfügbar in:
Hier erklären wir alles über (unsere) API mit einigen schönen Beispielen, wie Sie sie nutzen können und warum Sie sie nutzen sollten.

Was ist API?

API steht für Schnittstelle zur Anwendungsprogrammierung. Es ist die Schnittstelle, die es Software-Anwendungen ermöglicht, miteinander zu kommunizieren. Sie ermöglicht es Ihnen, etwas anzufordern oder eine Frage zu stellen, woraufhin der API-Aufruf die Aktion ausführt, die er tun soll, nachdem Sie ihn mit Informationen versorgt haben. In unserem Fall wäre dies die Anfrage, einen Teilnehmer zu einer Prüfung, einem Kurs oder der Akademie hinzuzufügen, wofür bestimmte Daten über den Teilnehmer erforderlich sind.

Beispiel 1

Wenn Sie in Ihrem Browser auf Facebook gehen, geht eine Anfrage an den Remote-Server von Facebook. Sobald Ihr Browser die Antwort erhält, interpretiert er den Code und zeigt die Seite an.

Für den Browser, der auch als Client bezeichnet wird, ist der Server von Facebook eine API. Das bedeutet, dass Sie jedes Mal, wenn Sie eine Seite im Web besuchen, mit einer API eines entfernten Servers interagieren.

Eine API ist nicht dasselbe wie der entfernte Server - vielmehr es ist der Teil des Servers, der Anfragen empfängt und Antworten sendet.

Beispiel 2

Stellen Sie sich vor, Sie sitzen an einem Tisch in einem Restaurant und haben eine Speisekarte zur Auswahl, aus der Sie bestellen können. Die Küche ist der Teil des "Systems", der Ihre Bestellung vorbereiten wird. Was fehlt, ist das entscheidende Bindeglied, um Ihre Bestellung an die Küche zu übermitteln und Ihr Essen an Ihren Tisch zu liefern. An dieser Stelle kommt der Kellner oder die API ins Spiel. Der Kellner ist der Bote - oder API - der Ihre Anfrage oder Bestellung entgegennimmt und der Küche - dem System - mitteilt, was zu tun ist. Dann liefert der Kellner die Antwort an Sie zurück; in diesem Fall ist es das Essen.

Wenn ein Unternehmen seinen Kunden eine API anbietet, bedeutet das, dass es eine Reihe von speziellen URLs eingerichtet hat, die reine Datenantworten zurückgeben - das heißt die Antworten enthalten nicht die Art von Präsentations-Overhead, die Sie bei einer grafischen Benutzeroberfläche wie einer Website erwarten würden.

Wofür verwende ich es?

Entwickler können verschiedene APIs auf unterschiedliche Weise verwenden, um verschiedene Dinge zu bauen. Facebook ist ein gutes Beispiel; die Seite startete ihre Entwicklerplattform namens F8 im Mai und beherbergt nun eine erstaunliche 10,900 Anwendungen vom berüchtigten Scrabulous über Instant Messaging bis hin zu Essenskampfspielen.

Der Vorteil für die Host-Site ist, dass sie viele neue, coole Funktionen kostenlos erhält, während die Entwickler ihre Arbeit auf einer bekannteren Site promoten und auf der Arbeit eines anderen aufbauen können. Die meisten dieser Anwendungen werden von Unternehmen mit einer eigenen Website entwickelt - oft kleinere Unternehmen mit weniger Traffic, die von dem Crossover profitieren. Die Filmkritikseite Flixster zum Beispiel hat eine beliebte Facebook-Anwendung, ebenso wie Last.fm und die Foto-Sharing-Seite Flickr.

Welche API-Aufrufe gibt es bei Easy LMS?

Easy LMS hat sechs API-Aufrufe die unterschiedlichen Funktionen dienen:

Teilnehmer hinzufügen zu Prüfung (einladen)
Teilnehmer hinzufügen zu Untersuchung ohne Benachrichtigung (keine Einladung)
Teilnehmer hinzufügen zu Kurs (einladen)
Teilnehmer hinzufügen zu Akademie (einladen)
Teilnehmer hinzufügen zu Akademie ohne Benachrichtigung (keine Einladung)
Teilnehmer löschen zu Daten des Teilnehmers (Damit werden alle Spuren eines Teilnehmers dauerhaft aus unserem System entfernt).

Die API-Aufrufe für eine Untersuchung funktionieren nur dann, wenn der Zugang eingestellt ist auf eine vordefinierte Gruppe von Teilnehmern, oder für einen Kurs, der nur auf Einladung stattfindet. Für die Akademie ist dies selbsterklärend. Es ist auch nicht möglich, einen dieser Aufrufe für dieselbe Prüfung, denselben Kurs oder dieselbe Akademie zu verwenden, wenn bereits ein Teilnehmer zu dieser hinzugefügt wurde. Das liegt daran, dass das Ziel dieser API-Aufrufe das Hinzufügen von Teilnehmern ist, wenn diese also bereits hinzugefügt wurden, funktioniert der API-Aufruf nicht.

Ein API-Aufruf besteht aus drei Dingen:

Die Nutzlast (die eigentlichen Daten, die gesendet werden)
Der Endpunkt (die Adresse, an die die Daten gesendet werden)
Die Antwort (Erfolgs- oder Fehlerantwort)

Die Nutzdaten sind die Informationen, die an einen Endpunkt gesendet werden, d. h. die Daten werden benötigt, um einen Teilnehmer zur Prüfung, zum Kurs oder zur Akademie hinzuzufügen.

Der Endpunkt ist eine Webadresse, an die die Informationen gesendet werden, und die Antwort zeigt an, ob der API-Aufruf erfolgreich war oder nicht.

Webhooks

Webhooks können in Verbindung mit API-Aufrufen verwendet werden, um verschiedene Aktionen zu initiieren. Wenn ein Webhook gesendet wird, der die erforderliche Nutzlast enthält, damit ein bestimmter API-Aufruf funktioniert, wird der API-Aufruf seine Arbeit tun und den Teilnehmer hinzufügen. Die Webhooks müssen von Ihrem System an unseren Endpunkt gesendet werden. Dies ist etwas, das Sie selbst in Ihrem System einrichten müssten.

Beispiel 1 - Kurs, Prüfung, Akademie

Die folgenden Absätze sind Teil eines fiktiven Anwendungsfalles, um zu erklären, wie Webhooks und APIs zusammenarbeiten können.

Ein Personalleiter hat einen Einstiegskurs und eine Prüfung für neu eingestellte Mitarbeiter erstellt. Der Personalleiter möchte, dass die Mitarbeiter den Kurs absolvieren, aber erst nach Abschluss des Kurses Zugriff auf die Prüfung erhalten. Erst nach Bestehen der Prüfung sollen die Mitarbeiter Zugang zur Akademie erhalten, die Kurse und Prüfungen auf mittlerem und hohem Niveau enthält. Wie kann man das einrichten?

Um zu verstehen, wie man dies einrichtet, haben wir bereits festgelegt, dass diese Webhooks und API-Aufrufe intern innerhalb des Easy LMS-Systems gesendet werden. Der Prozess ist wie folgt:

Der HR-Manager muss einen Webhook erstellen, der eine Nutzlast an die Prüfungs-API sendet, nachdem der Mitarbeiter den Kurs abgeschlossen hat. Dieser Webhook muss nur die Daten enthalten, die benötigt werden, um den Aufruf der Exam API auszulösen. In diesem Fall verwenden wir den Teilnehmer zur Prüfung hinzufügen (einladen) API-Aufruf. Wenn dieser Webhook gesendet wurde, wird der API-Aufruf ausgelöst, wenn es eine erfolgreiche Antwort gibt. Der API-Aufruf fügt den Teilnehmer hinzu und sendet automatisch die Prüfungseinladung.

Der zweite Webhook, den der HR-Manager erstellen muss, ist für den Fall, dass der Mitarbeiter die Prüfung erfolgreich bestanden hat, um Zugang zur Akademie zu erhalten. Auch hier sollte der Payload dieses Webhooks nur die Informationen enthalten, die der API-Aufruf der Akademie benötigt, um den Teilnehmer hinzuzufügen und eine Einladung zu senden. Nach dem Senden dieses "Prüfung bestanden"-Webhooks wird der Akademie-API-Aufruf ausgelöst, woraufhin er den Teilnehmer hinzufügt und eine Einladung für die Akademie sendet.

Um es zusammenzufassen:

Erstellen Sie einen Webhook für den Kursabschluss, der an den Prüfungs-API-Aufruf gesendet wird.
Erstellen Sie einen Webhook für die bestandene Prüfung, der an den API-Aufruf der Akademie gesendet wird.
Mitarbeiter nimmt Kurs und schließt ihn ab.
Webhook für den Kursabschluss wird gesendet an Teilnehmer zur Prüfung hinzufügen (einladen) API-Aufruf-Endpunkt und fügt Teilnehmer hinzu und lädt sie zur Prüfung ein.
Der Mitarbeiter nimmt an der Prüfung teil und besteht sie.
Webhook für bestandene Prüfung wird gesendet an Teilnehmer zur Akademie hinzufügen (einladen) API-Aufrufendpunkt und fügt Teilnehmer zur Akademie hinzu und lädt sie ein.



Beispiel 2 - Einladungen von Ihrem eigenen System aus senden

Ein Kunde möchte unser Tool für die Schulung seiner (neuen) Mitarbeiter nutzen. Er verwendet derzeit die Eine vordefinierte Gruppe von Teilnehmern Einstellung, um Einladungs-E-Mails zu versenden. Viele Mitarbeiter nehmen diese Einladungen jedoch als Spam wahr, und einige dieser E-Mails landen auch in ihren Spam-Ordnern. Der Kunde möchte diese Einladungen stattdessen von seinem eigenen System aus versenden.

Der Kunde erstellt zunächst einen Webhook, der eine Nutzlast an die Exam API - Teilnehmer hinzufügen ohne Benachrichtigung. Wenn ein neuer Mitarbeiter zu Ihrem System hinzugefügt wird, sendet der Webhook die Nutzlast an die Prüfungs-API, die den Mitarbeiter hinzufügt. Der API-Aufruf sendet keine Einladung an diesen Mitarbeiter. Wenn der API-Aufruf erfolgreich ist, enthält die Antwort die Anmeldeinformationen. Diese Anmeldeinformationen müssen dann von Ihrem eigenen System und Ihrer Mail-Anwendung an den Mitarbeiter gesendet werden.

Dies funktioniert auch für bestehende Mitarbeiter, Sie müssen nur einen Webhook erstellen, der eine Nutzlast an die Prüfungs-API sendet, die die Aktion des Hinzufügens von Teilnehmern ohne Benachrichtigung an die Prüfung auslöst. Die Anmeldedaten, die in der Antwort des API-Aufrufs zurückgegeben werden, können dann von Ihrem eigenen System aus gesendet werden.

Beispiel 3 - Verkaufen von Prüfungen

Ein Kunde erstellt Prüfungen in unserem System und verkauft sie an seine eigenen Kunden über seine E-Commerce-Website. Er möchte dies automatisieren, nachdem seine Kunden für eine Prüfung bezahlt haben.

Um seinen Verkaufsprozess zu automatisieren, muss er einen Webhook verwenden. Wenn seine Kunden eine Prüfung auf seiner E-Commerce-Website kaufen oder bezahlen, werden sie zu seinem System hinzugefügt. Der Webhook, den er erstellt, muss ausgelöst werden, nachdem sie bezahlt haben. Dieser Webhook sendet dann die entsprechende Nutzlast an den Exam-API-Aufruf und muss entweder eine (n) Erfolgs- oder eine Fehlerantwort zurückgeben. Wenn es eine erfolgreiche Antwort ist, fügt der API-Aufruf seine Kunden hinzu und lädt sie zu der Prüfung ein, für die sie bezahlt haben.



Wann werden die einzelnen API-Aufrufe verwendet und wie lauten ihre Spezifikationen?

Da jeder API-Aufruf eine andere Funktion hat, können sie verwendet werden, um unterschiedliche Dinge zu erreichen. Zum Beispiel, Teilnehmer zur Untersuchung hinzufügen (einladen) kann verwendet werden, um einen Teilnehmer hinzuzufügen und automatisch eine Einladung zu einer Prüfung zu senden, wenn dieser Trigger aktiviert ist.

Unsere API akzeptiert application/x-www-form-urlencoded oder multipart/form-data und json.

Erfahren Sie mehr über unsere Exam and Academy API-Aufrufe in diesem Artikel.

Erfahren Sie mehr über unseren Kurs-API-Aufruf in diesem Artikel.
War dieser Beitrag hilfreich?
Stornieren
Danke!