Einführung

Der Docebo-API-Browser ist innerhalb Ihrer Plattform verfügbar.

• Er enthält eine Referenzdokumentation für alle öffentlich verfügbaren API-Endpunkte von Docebo. Diese Dokumentation wird ständig mit der neuesten API-Version aktualisiert.
• Außerdem ist er interaktiv, d. h. Sie können API-Aufrufe für die Daten Ihrer Plattform direkt im API-Browser testen.

Dieser Artikel beschreibt, wie Sie auf den API-Browser Ihrer Plattform zugreifen, sich authentifizieren und mit den verschiedenen Endpunkten arbeiten können.

Zugriff auf den API-Browser

Den Zugriffslink zur API-Referenzdokumentation erhalten Sie, indem Sie /api-browser an Ihre Plattform-URL anhängen. Zum Beispiel:

https://.docebosaas.com/api-browser/

oder

https:///api-browser/

Die verfügbaren Microservices sind in der Combobox SERVICES aufgeführt. Wenn Sie einen neuen Microservice auswählen, wird seine spezifische Dokumentation automatisch geladen.

Tipp: Weitere Informationen zu den verschiedenen Microservices und Endpunkten finden Sie im Artikel Übersicht über die API-Services und Endpunkte.

Die Referenzdokumentation für einen Endpunkt anzeigen

Im Navigationsbereich auf der linken Seite:

1. Wählen Sie den gewünschten Microservice aus der Liste SERVICES (z. B. Course) aus, um dessen Dokumentation zu laden.
2. Klicken Sie dann unter API REFERENCE auf eine der Gruppierungen dieses Services (z. B. Categories), um die Liste seiner Endpunkte zu erweitern.
3. Klicken Sie abschließend auf einen bestimmten Endpunkt, um zu seiner Dokumentation zu springen.

Für den ausgewählten Endpunkt sehen Sie im rechten Bereich ein Response sample (Beispiel-Antwort) und falls zutreffend auch ein Body sample (Text-Beispiel). Sie können auf die Überschriften Body schema (Textschema) oder Response schema (Antwortschema) klicken, um die detaillierte Dokumentation aller Parameter zu erweitern.

Im mittleren Bereich befindet sich ein Bedienfeld, in dem Sie den Endpunkt interaktiv testen können, indem Sie einen Aufruf an den Daten Ihrer Plattform ausprobieren. Dazu müssen Sie jedoch zunächst wie im folgenden Abschnitt beschrieben ein Token abrufen.

Abrufen eines API-Zugriffstokens

Um Aufrufe über den API-Browser durchzuführen, benötigen Sie als Superadmin, Power User oder normaler Benutzer ein OAuth2-Zugriffstoken, das mit Ihren Plattform-Anmeldedaten verknüpft ist.

Bitte beachten: Docebo nutzt OAuth-Bereiche und -Berechtigungen, um den Zugriff auf die API zu ermöglichen, sodass die Endpunkte standardmäßig einem rollenbasierten Zugriffsmodell folgen. Die Berechtigungen, die Sie auf der Plattform haben, bestimmen die Ressourcen und Aktionen, auf die Sie über API-Aufrufe mit diesem Zugriffstoken zugreifen können.

Melden Sie sich zunächst bei der Plattform an. Alternativ können Sie sich auch nicht zu diesem Zeitpunkt anmelden und ihre Plattform-Anmeldedaten später eingeben.

1. Rufen Sie nun die API-Browserseite auf und klicken Sie für einen beliebigen Endpunkt im mittleren Bereich auf die Schaltfläche OAuth.
   
2. Klicken Sie im sich öffnenden Dialogfeld auf Authorize (Autorisieren). (Es ist nicht notwendig, auf den API Bereich zu klicken)
   
3. Jetzt werden Sie im Dialogfenster Autorisierung erforderlich als der Benutzer begrüßt, mit dem Sie sich zuvor angemeldet haben: Klicken Sie hier erneut auf Autorisieren.
   
   Hinweis: Wenn Sie sich zuvor nicht bei der Plattform angemeldet haben, werden Sie aufgefordert, Ihre Anmeldedaten einzugeben, bevor Sie auf Autorisieren klicken können.
   
4. Jetzt werden Sie zurück zur API-Browserseite weitergeleitet, auf der Sie sehen können, dass Sie angemeldet sind (auf der OAuth-Schaltfläche steht jetzt Signout (Abmelden)):
   
   Auch das Feld Token ist jetzt ausgefüllt:
   

Nun können Sie damit beginnen, API-Aufrufe für die Daten Ihrer Plattform durchzuführen.

Hinweis: Im Feld Token können Sie auch direkt ein zuvor generiertes OAuth2-Zugriffstoken einfügen

Testen eines Endpunkts im API-Browser

Sobald Sie im API-Browser ein Zugriffstoken eingegeben haben, können Sie Aufrufe an die Endpunkte testen. Wählen Sie dazu im Navigationsbereich des API-Browsers wie zuvor den Endpunkt aus und klicken Sie dann im mittleren Bereich auf die Schaltfläche Try (Testen).

Es öffnet sich ein Fenster, in dem Sie die tatsächliche Reaktion Ihrer Plattform auf diesen API-Aufruf untersuchen können:

Vorsicht: Die API-Aufrufe, die Sie hier durchführen, arbeiten mit den tatsächlichen Daten Ihrer Plattform. Seien Sie also vorsichtig mit Aufrufen (DELETE, POST, etc.), die Daten ändern oder löschen können.

Nächste Schritte

Um mehr über die Verwendung Ihres API-Browsers zu erfahren, einschließlich der Behandlung von Aufrufen, die Parameter erfordern, lesen Sie den Artikel Senden Ihrer ersten Anfragen mit dem API-Browser.