Dieser Artikel ist auch verfügbar in:
Dieser Artikel wurde mit maschineller Übersetzung übersetzt. Er könnte dementsprechend einige Fehler oder kuriose Formulierungen enthalten. Wir glauben trotzdem, dass es nützlich für Sie ist, diesen Hilfeartikel in Ihrer Sprache lesen zu können. Geben Sie uns nach dem Lesen aber gerne Bescheid, ob der Artikel hilfreich war, oder ob Sie sonstiges Feedback haben.

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.

Beispiel 1

Wenn Sie Facebook in Ihrem Browser aufrufen, wird eine Anfrage an den Remote-Server von Facebook gesendet. 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. Hier kommt der Kellner, oder 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 und beherbergt nun eine erstaunliche 10,900 Anwendungen vom berüchtigten Scrabulous über Instant Messaging bis hin zu Essenskampfspielen.

Der Vorteil für die gastgebende Seite ist, dass sie viele neue, coole Funktionen kostenlos erhält, während die Entwickler ihre Arbeit auf einer bekannteren Seite promoten und auf der Arbeit von jemand anderem 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?

Wir haben sechs API-Aufrufe, die unterschiedlichen Funktionen dienen:

Teilnehmer zu Prüfung hinzufügen (einladen)
Teilnehmer zu Prüfung hinzufügen ohne Benachrichtigung (keine Einladung)
Teilnehmer zu Kurs hinzufügen (einladen)
Teilnehmer zu Academy hinzufügen (einladen)
Teilnehmer zu Academy hinzufügen, ohne zu benachrichtigen (keine Einladung)
Teilnehmer löschen (entfernt alle Teilnehmerdaten dauerhaft aus unserem System)

Die API-Aufrufe für eine Prüfung funktionieren nur dann, wenn der Zugriff eingestellt ist auf eine vordefinierte Gruppe von Teilnehmern, oder für eine Kurs, die Nur per Einladung. Für die Academy ist dies selbsterklärend. Es ist auch nicht möglich, einen dieser Aufrufe für dieselbe Prüfung, Kurs oder Academy zu verwenden, wenn bereits ein Teilnehmer 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, also die Daten, die zum Hinzufügen/Löschen eines Teilnehmers benötigt werden.

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/löschen. 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, Academy

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

Ein Personalleiter hat eine Einstiegsprüfung Kurs und Prüfung für neu eingestellte Mitarbeiter erstellt. Der Personalleiter möchte, dass die Mitarbeiter den Kurs absolvieren, aber erst nach Abschluss des Kurs Zugriff auf den Prüfung erhalten. Erst nach Bestehen des Prüfung möchte er, dass die Mitarbeiter Zugriff auf das Academy haben, das Prüfungen auf mittlerer und Expertenebene Kurss und Prüfungen 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üfung API sendet, nachdem der Mitarbeiter die kurs ausgefüllt hat. Dieser Webhook muss nur die Daten enthalten, die zum Auslösen des Prüfung API-Aufrufs benötigt werden. In diesem Fall verwenden wir den Teilnehmer zu 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üfung Einladung.

Der zweite Webhook, den der Personalleiter erstellen muss, ist für den Fall, dass der Mitarbeiter die Prüfung erfolgreich durchläuft, um Zugriff auf die Academy zu erhalten. Auch hier sollte der Payload dieses Webhooks nur die Informationen enthalten, die der Academy API-Aufruf benötigt, um den Teilnehmer hinzuzufügen und eine Einladung zu senden. Nach dem Senden dieses ''Prüfung passed'' Webhooks wird der Academy API-Aufruf ausgelöst, der den Teilnehmer hinzufügt und eine Einladung für die Academy sendet.

Um es zusammenzufassen:

Erstellen Sie einen Webhook für Kurs bestanden, der an den Prüfung API-Aufruf gesendet wird.
Erstellen Sie einen Webhook für die Übergabe von Prüfung , der an den Academy API-Aufruf gesendet wird.
Mitarbeiter nimmt Kurs und vervollständigt es.
Webhook für Kurs Fertigstellung wird gesendet an Teilnehmer zu Prüfung hinzufügen (einladen) API-Aufruf-Endpunkt und fügt Teilnehmer zur Prüfung hinzu und lädt sie ein.
Mitarbeiter nimmt Prüfung ab und besteht.
Webhook für das Bestehen Prüfung wird gesendet an Teilnehmer zu Academy hinzufügen (einladen) API-Aufruf-Endpunkt und fügt Teilnehmer zur Prüfung Academy hinzu und lädt ihn ein.



Beispiel 2 - Einladungen von Ihrem eigenen System aus versenden

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 einen Payload an die Prüfung API - Teilnehmer hinzufügen ohne Benachrichtigung. Wenn ein neuer Mitarbeiter zu Ihrem System hinzugefügt wird, sendet der Webhook die Payload an die Prüfung 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 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üfung 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 Prüfungen

Ein Kunde erstellt Prüfungen in unserem System und verkauft sie über seine E-Commerce-Website an seine eigenen Kunden. 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 Prüfung 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.



5. Wie lauten die Spezifikationen für den API-Aufruf?

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

Erfahren Sie mehr in den folgenden Artikeln:

API-Aufrufe für Prüfungen und Academy

API-Aufruf für Kurss

Teilnehmer-API löschen
War dieser Beitrag hilfreich?
Stornieren
Danke!