Einführung

Der Docebo-API-Browser ist eine Schnittstelle, mit der Sie die auf Ihrer Plattform verfügbaren API-Endpunkte erkunden und damit interagieren können. In diesem Leitfaden erfahren Sie, wie Sie den API-Browser verwenden, um zu überprüfen, ob eine API für eine bestimmte Aktion vorhanden ist, z. B. für das Erstellen von Benutzern, das Exportieren von Berichten oder die Verwaltung von Lerninhalten. Im API-Browser können Sie alle Dienste und die zugehörigen Endpunkte anzeigen und prüfen, welche Vorgänge unterstützt werden, welche Parameter erforderlich sind und wie Sie jeden Endpunkt verwenden, um Aufgaben auf Ihrer Plattform auszuführen.

Anweisungen für den Zugriff auf den API-Browser und die Authentifizierung finden Sie im Artikel Erste Schritte mit dem Docebo-API-Browser.

Denken Sie daran: Wenn Sie den API-Browser verwenden, werden alle Aktionen wirklich ausgeführt, was sich direkt auf Ihre Plattform auswirkt. Es handelt sich nicht nur um Tests, seien Sie also vorsichtig beim Ausführen von Aktionen.

Einführung zu den Services und Endpunkten

Im API-Browser sind die Aktionen in Services gruppiert. Ein Service stellt einen Teil der Funktionalität der Plattform dar, z. B. die Benutzerverwaltung, die Bearbeitung von Transaktionen oder die Datenverarbeitung.

Jeder Service hat Endpunkte, also spezifische URLs, die zur Durchführung von Aktionen verwendet werden. Wenn Sie z. B. den Service manage (Verwalten) auswählen, finden Sie beim Erweitern der Gruppierung Users (Benutzer) folgende Endpunkte:

• GET /manage/v1/users: Ruft eine Liste von Benutzern ab
• POST /verwalten/v1/Benutzer: Erstellt einen neuen Benutzer

Wenn Sie auf ähnlicher Weise den Service learn (Lernen) auswählen, finden Sie beim Erweitern der Gruppierung Catalogue (Katalog) die folgenden Endpunkte:

• GET /learn/v1/catalog/filters: Ruft alle Filteroptionen für einen Katalog ab

Der API-Browser führt Sie durch die Nutzung dieser Services und zeigt Ihnen, welche Informationen (Parameter) Sie bereitstellen müssen, wie Sie Ihre Anfragen formatieren und welche Art von Antworten Sie erwarten können. Er enthält auch Details zur Authentifizierung und Beispiele, damit Sie die API effektiv nutzen können.

Kurzübersicht zu den API-Browserdiensten

Die folgende Tabelle gibt einen Überblick darüber, wo die verschiedenen Funktionen in den einzelnen API-Services zu finden sind. Diese Zusammenfassung hilft Ihnen, schnell den richtigen Service und die zugehörigen Endpunkte auf der Grundlage der von Ihnen benötigten Funktionen zu finden. Beachten Sie, dass einige Funktionen von mehr als einem Service abgedeckt werden können.

Learn

Dieser Service umfasst sowohl formelle als auch informelle Lernaktionen auf der Plattform, darunter:

• E-Learning- und vILT-Kurse und -Sitzungen sowie externe Schulungen
• Verwaltung der Einschreibungen für Kurse und Lernpläne
• Verwaltung von Kanälen und Assets
• Schulungsunterlagen und Assets, wie Umfragen, Tests, Foren und Dateiablagebereiche für Kurse
• Abonnementpakete

Skill

Die Endpunkte für die Verwaltung von Benutzerfähigkeiten auf der Plattform:

• Zuweisung von Fähigkeiten zu Benutzern, Kursen und Profilen
• Endpunkte der Manager- und Mein Team-Funktionen
• Integrations-APIs für externe Talentmanagement-Systeme

Share

Behandelt die Verwaltung des informellen Lernens, unter anderem:

• Assets, Kanäle, Fragen & Antworten und Experten von Coach & Share
• Gamifizierungsfunktionen

Manage

Umfasst die allgemeinen Plattformverwaltungsfunktionen, wie z. B.:

• Benutzerverwaltung, zentrale Ablage, Einschreibungsregeln, Hintergrundjobs und mobile App
• Extended Enterprise (Multidomain), **Zweigstruktur, Branding-Konfigurationen
• Globale Suche, Cookie-Richtlinie, Datenschutz und Allgemeine Geschäftsbedingungen

Notifications

Enthält Endpunkte in Bezug auf:

• Benachrichtigungen und DKIM-Konfiguration**

E-commerce

Enthält:

• Endpunkte für Transaktionen, Rechnungsinformationen und E-Commerce-Konfigurationen

Marketplace

Die Endpunkte in diesem Service befassen sich mit:

• Marktplatz-Inhaltsanbieter (GO1, LinkedIn Learning und OpenSesame). Die verfügbaren Endpunkte variieren je nach Inhaltsanbieter.

Report

Die Endpunkte konzentrieren sich auf:

• Dashboard-Daten und Abruf von benutzerdefinierten Berichten (Legacy-Berichte)
• Anfrage-Generator-Berichte

Pages

Enthält Endpunkte für:

• Verwaltung von Menüs und Seiten (Erstellen, Bearbeiten, Löschen)

OTJ

Behandelt:

• Beobachtungschecklisten (Verwalten, Hochladen, Genehmigen oder Ablehnen)

Audittrail

Enthält:

• Endpunkte für Audit Trail-Abfragen und -Protokolle

Course

Die Kurs-Service-Endpunkte befassen sich mit:

• E-Learning-Kurse, ILT-Kursveranstaltungen, Sitzungen und Verwaltung von Miniaturansichten

Analytics

Umfasst:

• Anfrage-Generator, neue benutzerdefinierte Berichte, Berichts-Dashboards und Manager-Berichte

Audiences

Enthält:

• Endpunkte für die Verwaltung von Gruppen und Benutzern

Poweruser

Enthält:

• Endpunkte für Power User-Berechtigungen, -Profile und -Ressourcenzuweisungen

Learningplan

Umfasst:

• Lernplanverwaltung und Lernplan-Einschreibekonfigurationen

Enrollment

• Enthält nur Endpunkte für archivierte Einschreibungen

Certification

Behandelt:

• Endpunkte für erteilte Zertifizierungen.

Services, für die es derzeit keine aktivierbaren Endpunkte im API-Browser gibt

• Impact
• Proctoring
• External
• Conference tool
• Messenger

Veraltete Kategorien

• Webinar

Unter dem Microservice Learn sind die meisten Webinar-Endpunkte veraltet oder werden nicht mehr unterstützt.

Verwendung von Endpunkten

Im Folgenden finden Sie eine Übersicht darüber, wie Sie den benötigten Endpunkt identifizieren und dessen Verwendung verstehen.

Den Service und den Endpunkt finden:

Im API-Browser, suchen Sie nach dem Service, der die von Ihnen gewünschte Aktion enthält (z. B. Benutzerverwaltung, Aktualisierung von Kursen). Wählen Sie den gewünschten Service aus der Dropdown-Liste Services aus.

Sobald Sie sich im richtigen Service befinden, scrollen Sie immer noch im linken Bereich nach unten, um den spezifischen Endpunkt im Rahmen der Überschrift API-Reference zu finden (in diesem Beispiel Retrieves content of the given catalog bzw. Ruft den Inhalt des angegebenen Katalogs ab). Dort ist die API-URL zugänglich.

Endpunktdetails anzeigen:

Nachdem Sie den Endpunkt ausgewählt haben, sehen Sie im mittleren Bereich die Parameter, die Ihnen dabei helfen, Ihre Anfrage zu verfeinern. Zu diesen Parametern können gehören:

• Erforderliche Parameter: Informationen, die Sie angeben müssen, um den Endpunkt erfolgreich auszuführen.
• Optionale Filter: Optionen zum Eingrenzen der Ergebnisse (z. B. Filtern nach einem bestimmten Benutzer)
• Ergebnisgröße: Sie können festlegen, wie viele Ergebnisse pro Seite Sie wünschen
• Sortieroptionen: Wählen Sie, wie die Ergebnisse sortiert werden sollen (z. B. nach Datum oder Name)

Wenn Sie die richtigen Parameter und Konfigurationen eingeben, können Sie sicherstellen, dass der Endpunkt reibungslos und fehlerfrei funktioniert.

Beispielantwort anzeigen:

Auf der rechten Seite des API-Browsers sehen Sie ein Beispiel für die Endpunktantwort. Diese Antwort zeigt, welche Art von Daten Sie erhalten, wenn der Endpunkt erfolgreich aufgerufen wird. Beispiele für Datentypen sind:

• String: Eine Zeichenfolge bzw. String ist eine Sammlung von Zeichen, wie Wörter oder Text. Zum Beispiel: „Hallo Welt“.
• Integer: Eine ganze Zahl (engl. Integer) ist eine Zahl ohne Dezimalstellen. Zum Beispiel: 25 oder 100.

Die Beispielantwort hilft Ihnen, das Format der Daten zu verstehen, die der Endpunkt zurückgibt, damit Sie wissen, was Sie bei Ihren API-Anfragen erwarten können.

Überprüfen des Antwortschemas:

Im rechten Bereich, unterhalb der Beispielantwort, finden Sie das Response schema (Antwortschema). Dieser Abschnitt enthält eine detaillierte Definition und Erklärung jedes in der Antwort enthaltenen Elementes. Es wird aufgeschlüsselt, was jedes Feld in der Antwort bedeutet und welchen Datentyp es enthält (z. B. Zeichenfolge oder Ganzzahl).

Wenn die Antwort z. B. die Details eines Katalogs enthält, kann das Schema Folgendes erklären:

• "id" (String): Die Katalog-ID.
• "name" (String): Der Name des Katalogs.
• "description" (String): Die Beschreibung des angeforderten Katalogs.

Dies hilft Ihnen, die Struktur und die Bedeutung der vom Endpunkt zurückgegebenen Daten zu verstehen.