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.

API steht für Anwendungsprogrammierschnittstelle. Es ist die Schnittstelle, über die Softwareanwendungen miteinander kommunizieren können. 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 ihm die Informationen geliefert haben.

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 bringen. Hier kommt der Kellner, oder API, ins Spiel. Der Kellner ist der Bote - oder die 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 das Essen.

Zusammenfassend lässt sich sagen, dass ein Unternehmen, das seinen Kunden eine API anbietet, lediglich eine Reihe spezieller URLs eingerichtet hat, die reine Datenantworten zurückliefern - d. h. die Antworten enthalten nicht die Art von Präsentationsaufwand, die man bei einer grafischen Benutzeroberfläche wie einer Website erwarten würde.

Wir haben fünf API-Aufrufe, die verschiedenen Funktionen dienen.

Ein API-Aufruf besteht aus drei Teilen:

Die Nutzdaten sind die Informationen, die an einen Endpunkt gesendet werden, d. h. die Daten, die erforderlich sind, um einen Teilnehmer 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 können in Verbindung mit API-Aufrufen verwendet werden, um verschiedene Aktionen auszulösen. 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 und müssen selbst in Ihrem System eingerichtet werden.

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

Ein Personalleiter hat einen Kurs 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 Zugang zur Prüfung erhalten. Erst nach Bestehen der Prüfung sollen die Mitarbeiter Zugang zur academy erhalten, die Kurse und Prüfungen für Fortgeschrittene und Experten enthält. Wie kann man das also 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 läuft folgendermaßen ab.

Der Personalleiter muss einen Webhook erstellen, der eine Nutzlast an die API für Prüfungen sendet, nachdem der Mitarbeiter den Kurs abgeschlossen hat. Dieser Webhook muss nur die Daten enthalten, die zum Auslösen des Aufrufs der Prüfungs-API erforderlich sind. In diesem Fall verwenden wir den API-Aufruf Teilnehmer zur Prüfung hinzufügen (einladen). 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 Einladung zur Prüfung.

Der zweite Webhook, den der Personalleiter erstellen muss, ist für den Fall, dass der Mitarbeiter die Prüfung erfolgreich bestanden hat, um Zugang zur academy zu erhalten. Auch hier sollte die Nutzlast dieses Webhooks nur die Informationen enthalten, die der API-Aufruf der academy benötigt, um den Teilnehmer hinzuzufügen und eine Einladung zu versenden. Nach dem Senden dieses Webhooks wird der Academy-API-Aufruf ausgelöst, der den Teilnehmer zur academy hinzufügt und eine Einladung versendet.

Zusammengefasst:

Ein Kunde möchte unser Tool für die Schulung seiner (neuen) Mitarbeiter nutzen. Derzeit verwendet er die Einstellung Eine vordefinierte Gruppe von Teilnehmern, um Einladungs-E-Mails zu versenden. Viele Mitarbeiter empfinden diese Einladungen jedoch als Spam, 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 API für Prüfungen - Teilnehmer hinzufügen ohne Benachrichtigung- sendet. Wenn ein neuer Mitarbeiter zu Ihrem System hinzugefügt wird, sendet der Webhook den Payload 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 Anmeldedaten. Diese Anmeldedaten müssen dann von Ihrem eigenen System und Ihrer E-Mail-Anwendung an den Mitarbeiter gesendet werden.

Sie müssen lediglich einen Webhook erstellen, der eine Nutzlast an die Prüfungs-API sendet, die die Aktion des Hinzufügens von Teilnehmern ohne Benachrichtigung der Prüfung auslöst. Die Anmeldedaten, die in der Antwort auf den API-Aufruf zurückgegeben werden, können dann von Ihrem eigenen System gesendet werden.

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 die Kunden für eine Prüfung bezahlt haben.

Um den Verkaufsprozess zu automatisieren, muss er einen Webhook verwenden. Wenn ihre Kunden eine Prüfung auf ihrer E-Commerce-Website kaufen oder bezahlen, werden sie zu ihrem System hinzugefügt. Der von ihnen erstellte Webhook muss ausgelöst werden, nachdem sie bezahlt haben. Dieser Webhook sendet dann die entsprechende Nutzlast an den API-Aufruf der Prüfung und muss entweder eine Erfolgs- oder eine Fehlerantwort zurückgeben. Bei einer erfolgreichen Antwort fügt der API-Aufruf Kunden hinzu und lädt sie zu der Prüfung ein, für die sie bezahlt haben.
​

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

Weitere Informationen finden Sie in den folgenden Artikeln: