Zum Hauptinhalt springen

API-Schnittstelle

The API Interface is a representation of the ExoClick API designed to detail available requests, their associated parameters and their expected responses. You can view it from the Admin Panel.

Alle API-Anfragen werden unter ihrer zugehörigen Gruppe aufgeführt.

Um auf eingeschränkte API-Anfragen zugreifen zu können, muss ein Session Token gesetzt werden. Um ein Token zu setzen, müssen Sie ein gültiges Konto mit dem erforderlichen Benutzernamen und Passwort oder ein API-Token haben. Klicken Sie auf die Schaltfläche Anmelden oben rechts auf dem Bildschirm und geben Sie Ihren Benutzernamen und Ihr Kennwort ein oder stellen Sie ein API-Token bereit. Nachdem Sie auf die Schaltfläche Anmelden geklickt haben, wird eine Anmeldeanfrage an die API gestellt, um ein gültiges Sitzungs-Token zu erhalten. Dieses Token wird dann zur Validierung aller API-Anfragen verwendet, die Sie in dieser Sitzung stellen möchten.

Um eine Anfrage an die API zu stellen, klicken Sie auf eine Gruppe. Die Gruppe wird erweitert, um die verfügbaren Anfragen aufzulisten. Klicken Sie erneut auf die gewünschte Anfrage. Es öffnet sich ein Fenster mit den Details der Anfrage.

  • Der Response-Body wird, falls vorhanden, neben dem Content-type der Antwort zuerst angezeigt.

  • Die Anforderungsparameter, die erforderlich und/oder optional sind, werden im Folgenden zusammen mit dem Content-type der Anforderung, falls erforderlich, aufgeführt.

  • Die erwarteten Antwortnachrichten werden dann aufgelistet.

  • Um die Anfrage zu stellen, geben Sie die erforderlichen Parameter ein. Wenn der Anforderungskörper detailliert ist, wird durch Klicken auf den Körper im Fenster Modell das Parameterfenster mit dem Körper vorausgefüllt.

  • Wenn alle erforderlichen Parameter eingestellt sind, wird die Anfrage durch Klicken auf die Schaltfläche Ausprobieren ausgeführt.

  • Unter der Schaltfläche werden vier Felder angezeigt:

    • Die erste zeigt die vollständige Anforderungs-URL an.
    • Die zweite enthält den Response Body.
    • Die dritte Angabe ist der Antwortcode.
    • Der vierte Abschnitt enthält die Antwortkopfzeilen.