So testen Sie eine API im Developer Center

Sie können jede in Ihrer Organisation verfügbare API direkt über die Seite API-Explorer in Cloud Services-Konsole testen.

Voraussetzungen

Sie müssen über eine Rolle vom Typ Organisationsbesitzer in der Organisation verfügen.

Prozedur

1. Melden Sie sich bei Ihrer Organisation in der Cloud Services-Konsole an.
2. Navigieren Sie zu Developer Center > API-Explorer.
3. Wählen Sie im Menü Verfügbare APIs auf der Seite API-Explorer eine API-Kategorie aus.
   Die Seite wird aktualisiert und zeigt alle verfügbaren APIs in der ausgewählten Kategorie an.
4. Verwenden Sie das Pfeilsymbol, um den Inhalt einer API anzuzeigen.
5. Scrollen Sie nach unten zum Abschnitt Ausprobieren.
   
6. Um einen API-Aufruf zu erstellen, füllen Sie die erforderlichen Eigenschaften aus.
   Eigenschaften werden nach Möglichkeit basierend auf den Umgebungsdetails, die auf der rechten Seite der Seite angezeigt werden, vorab ausgefüllt.
   Wenn Sie API-Integrationen oder Serveraufrufe lokal erstellen oder verwenden, können Sie Ausschnitte aus den Beispielen der API-Spezifikationen verwenden. Um dies zu tun, klicken Sie auf die Schaltfläche Open API-/Swagger-Spezifikation herunterladen, die oben und unten auf der Seite API-Explorer zu finden ist. Die Spezifikationsdatei enthält Beispielaufrufe und erwartete Antworten.
7. Klicken Sie auf Ausführen.
   Hinweis: Alle API-Aufrufe, die Sie über den API-Explorer vornehmen, werden für Ihre Live-Umgebung ausgeführt. Lassen Sie grundsätzlich Vorsicht walten, wenn Sie die Funktion Ausprobieren verwenden.

Ergebnisse

Wenn Sie den API-Aufruf ausführen, wird die Seite aktualisiert und zeigt die Antwort direkt unter dem Abschnitt Ausprobieren der Seite API-Explorer an. Sie können mit der Modellantwort interagieren, die Nutzlast im Textformat anzeigen oder die Antwort kopieren oder herunterladen.

Beispiel:

In diesem Beispiel verwenden Sie eine API aus der Kategorie „Identitäts- und Zugriffsverwaltung“, um Informationen über den Hauptbenutzer abzurufen – dem Benutzer, der aktuell bei der Organisation angemeldet ist.

1. Öffnen Sie den API-Explorer.
2. Wählen Sie in der Liste Verfügbare APIs die Option Identitäts- und Zugriffsverwaltung aus.
3. Klicken Sie in der jetzt angezeigten Liste der API-Kategorien auf Hauptbenutzer.
4. Klicken Sie auf GET /am/api/loggedin/user.
5. Klicken Sie auf Ausführen.

Die Antwort für den von Ihnen erstellten API-Aufruf wird im Abschnitt Antwort der Seite angezeigt und gibt die Benutzerinformationen zurück, die Sie für die Anmeldung bei der Organisation verwendet haben.