Entwickler-Dokumentation

Bei einer REST-API handelt es sich um eine sehr geläufige Art von Computerschnittstelle. Eine gute Analogie in der realen Welt sind → Geldautomaten.

Um Geld abzuheben werden folgende Schritte ausgeführt:

  • Ein Bankkunde geht zu einem Bankautomaten

  • Der Kunde authentifiziert sich am Automaten (Kreditkarte + Passwort)

  • Erteilt dem Automaten einen Befehlt → 100 € abheben

  • Wenn die Anfrage valide ist, führt der Automat diese aus, ansonsten gibt er eine Fehlermeldung zurück

Eine REST-API funktioniert sehr ähnlich:

  • Ein Computerprogramm spricht die REST-API an

  • Die Anfrage enthält einen Authentifizierungsschlüssel

  • Die Anfrage enthält eine Anweisung → Bitte gib mir die Liste aller Benutzer

  • Wenn der Authentifizierungsschlüssel valide ist, sendet unser Server dem Computerprogramm die Liste aller Benutzer zurück, ansonsten antwortet der Server mit einer Fehlermeldung

Eine REST-API ist wie ein Bankautomat - passiv. Beide müssen angesprochen werden, erst dann bearbeiten sie eine Anfrage. Um zu verhindern, dass eine fremde Person die eigenen Daten einsieht oder unbefugt Geld abhebt, muss eine Anfrage authentifiziert werden. Wie ein Geldautomat erlaubt eine REST-API nur eine Auswahl an Anfragen und führt diese nur aus, wenn die Anfrage valide ist.

In der Entwickler-Dokumentation steht, welche Anfragen eine REST-API unterstützt und welche Parameter vom anfragenden Computerprogramm übergeben werden müssen. Um einen Benutzer zu erstellen, muss die Anfrage z.B. den Benutzernamen, die E-Mail-Adresse, die Sprache und ein paar weitere Informationen enthalten.

Mit REST-API Benutzer verwalten

Die Fähigkeiten einer REST-API können von einem Programmierer beliebig eingesetzt werden. Ein Use-Case ist das automatische Verwalten von Benutzern. Wird in ihrem System ein neuer Mitarbeiter angelegt, erstellt Ihr System über eine REST-API Anfrage automatisch den Benutzer auch in keelearning. Heiratet jemand, wird der Name synchronisiert. Verlässt jemand das Unternehmen, wird er automatisch gelöscht. Eine einmal eingerichtete Computerschnittstelle erspart sehr viel Handarbeit.

FAQ

Q: Wer kann eine REST-API verwenden?

A: Ein Programmierer.

Q: Benötige ich besondere Software um eine REST-API anzusprechen?

A: Nein. Mit allen gängigen Programmiersprachen kann eine REST-API angesprochen werden.

Q: Gibt es eine Möglichkeit die Computerschnittstelle vorab zu testen?

A: Ja. Nach dem Buchen der REST-API erhalten Sie von uns ein dauerhaftes Testsystem. Zudem bietet Swagger eine Mocking-API an die auch ohne Authentifizierungscode verwendet werden kann.

Use-Cases

Benutzerdaten synchronisieren

Sie verwalten alle Mitarbeiter Ihrer Firma in einem zentralen System und möchten, dass auch im keelearning LMS die User immer aktuell sind, da von Zeit zu Zeit Neuzugänge hinzu kommen, Menschen heiraten und dadurch ihren Nachnamen ändern. Über die REST-API ist es möglich genau diesen Datenabgleich zu automatisieren. Wir bieten ein standardisierten Weg um Daten in unser System zu schreiben oder zu lesen.


Daten in Drittanbieter-Software auswerten

Sie möchten den Fortschritt Ihrer Benutzer in einem anderen Tool verfolgen, z.B. ob ein Benutzer bereits einen bestimmten Kurs absolviert hat oder nicht, oder alle Zertifikate eines Benutzer herunterladen und in einem anderen System speichern. Rufen Sie einfach über die REST-API die Kurs-Statistikdaten ab und verarbeiten Sie die Daten (JSON-Format) in einer anderen Software weiter.



Akademie

Sie betreiben eine Akademie in der Präsenz- und Online-Schulungen stattfinden. Um Ihre Kunden beim Lernen zu unterstützen setzen Sie das keelearning LMS ein und möchten, dass sobald ein Kunde einen Kurs auf Ihrer Webseite gebucht hat, dieser auch Zugriff, für eine beschränkte Zeit, auf das keelearning LMS bekommt. Über die REST-API ist es möglich Benutzer computergesteuert zu erstellen, zu sperren, zu aktualisieren, ihnen neue Inhalte zuzuweisen, oder zu löschen. Die REST-API erlaubt es Ihnen, Ihren ganz eigenen idealen Weg umzusetzen.

Zur Entwickler-Dokumentation

War diese Antwort hilfreich für dich?