Hier erklären wir Ihnen anhand einiger anschaulicher Beispiele alles über (unsere) API, wie Sie sie nutzen können und warum Sie sie nutzen sollten.

API steht für Application Programming Interface (Anwendungsprogrammierschnittstelle). Es handelt sich um die Schnittstelle, die es Softwareanwendungen ermöglicht, miteinander zu kommunizieren. Im Grunde genommen können Sie damit eine Anfrage stellen oder eine Frage stellen, woraufhin der API-Aufruf die vorgesehene Aktion ausführt, nachdem Sie ihm die erforderlichen Informationen zur Verfügung gestellt haben.

Stellen Sie sich vor, Sie sitzen an einem Tisch in einem Restaurant und haben eine Speisekarte mit verschiedenen Gerichten zur Auswahl. Die Küche ist der Teil des „Systems“, der Ihre Bestellung zubereitet. Was fehlt, ist die entscheidende Verbindung, um Ihre Bestellung an die Küche weiterzuleiten und Ihr Essen an Ihren Tisch zu bringen. Hier kommt der Kellner – oder die 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. Anschließend überbringt der Kellner die Antwort an Sie; in diesem Fall ist das das Essen.

Zusammenfassend lässt sich sagen: Wenn ein Unternehmen seinen Kunden eine API anbietet, bedeutet das lediglich, dass es eine Reihe spezieller URLs eingerichtet hat, die reine Datenantworten zurückgeben – das heißt, die Antworten enthalten keinen darstellungsbezogenen Overhead, wie man ihn von einer grafischen Benutzeroberfläche wie einer Website erwarten würde.

Wir haben fünf API-Aufrufe, die unterschiedliche Funktionen erfüllen.

Ein API-Aufruf besteht aus drei Komponenten:

Die Nutzlast ist die Information, die an einen Endpunkt gesendet wird, d. h. die Daten, die zum Hinzufügen eines Teilnehmers erforderlich sind.

Der Endpunkt ist eine Webadresse, an die die Informationen gesendet werden, und die Antwort gibt 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, führt der API-Aufruf seine Aufgabe aus und fügt den Teilnehmer hinzu. Die Webhooks müssen von Ihrem System an unseren Endpunkt gesendet werden und müssen von Ihnen selbst in Ihrem System eingerichtet werden.

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

Ein Personalmanager hat einen Einsteigerkurs und eine Prüfung für neu eingestellte Mitarbeiter erstellt. Der Personalmanager möchte, dass die Mitarbeiter den Kurs absolvieren, ihnen aber erst nach Abschluss des Kurses Zugang zur Prüfung gewähren. 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 lässt sich das also einrichten?

Um zu verstehen, wie dies eingerichtet wird, haben wir bereits festgestellt, dass diese Webhooks und API-Aufrufe intern innerhalb des Easy LMS-Systems gesendet werden. Der Ablauf ist wie folgt.

Der Personalverantwortliche muss einen Webhook erstellen, der nach Abschluss des Kurses durch den Mitarbeiter eine Nutzlast an die API für Prüfungen sendet. Dieser Webhook muss lediglich die Daten enthalten, die zum Auslösen des API-Aufrufs für die Prüfung erforderlich sind. In diesem Fall verwenden wir den API-Aufruf Teilnehmer zur Prüfung hinzufügen (Einladung). Wenn dieser Webhook gesendet wurde, wird der API-Aufruf bei einer erfolgreichen Antwort ausgelöst. Der API-Aufruf fügt den Teilnehmer hinzu und versendet automatisch die Einladung zur Prüfung.

Der zweite Webhook, den der Personalverantwortliche erstellen muss, ist für den Fall vorgesehen, dass der Mitarbeiter die Prüfung erfolgreich besteht und Zugang zur Academy erhält. 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 API-Aufruf der Academy ausgelöst, woraufhin dieser den Teilnehmer zur Academy hinzufügt und eine Einladung versendet.

Zusammenfassend:

Ein Kunde möchte unser Tool zur Schulung seiner (neuen) Mitarbeiter nutzen. Derzeit nutzt er die Einstellung Eine vordefinierte Teilnehmergruppe, um Einladungs-E-Mails zu versenden. Viele Mitarbeiter empfinden diese Einladungen jedoch als Spam, und einige dieser E-Mails landen zudem in ihren Spam-Ordnern. Der Kunde möchte diese Einladungen stattdessen über sein eigenes System versenden.

Der Kunde erstellt zunächst einen Webhook, der eine Nutzlast an die Prüfungs-API – Teilnehmer hinzufügen, ohne zu benachrichtigen sendet. 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 Anmeldedaten. Diese Anmeldedaten müssen dann vom eigenen System und der E-Mail-Anwendung an den Mitarbeiter gesendet werden.

Dies funktioniert auch für bestehende Mitarbeiter; Sie müssen lediglich einen Webhook erstellen, der eine Nutzlast an die Prüfung-API sendet, wodurch die Aktion zum Hinzufügen von Teilnehmern ohne Benachrichtigung an die Prüfung ausgelöst wird. Die in der Antwort des API-Aufrufs zurückgegebenen Anmeldedaten können dann von Ihrem eigenen System aus gesendet werden.

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

Um den Verkaufsprozess zu automatisieren, muss ein Webhook verwendet werden. Wenn Kunden auf der E-Commerce-Website eine Prüfung kaufen oder bezahlen, werden sie in das System des Anbieters aufgenommen. Der von ihm erstellte Webhook muss nach erfolgter Bezahlung ausgelöst werden. Dieser Webhook sendet dann die entsprechenden Daten an den API-Aufruf für die Prüfung und muss entweder eine Erfolgs- oder eine Fehlerantwort zurückgeben. Bei einer erfolgreichen Antwort fügt der API-Aufruf die Kunden der von ihnen bezahlten Prüfung hinzu und lädt sie dazu ein.
​

Unsere API akzeptiert „application/x-www-form-urlencoded“, „multipart/form-data“ und JSON.

Erfahren Sie mehr in den folgenden Artikeln: