API-Schnittstelle

Die API-Schnittstelle ist eine Darstellung der ExoClick-API, die dazu dient, verfügbare Anfragen, die zugehörigen Parameter und die zu erwartenden Antworten zu beschreiben. Sie können sie im Admin-Panel ansehen.

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

Um auf eingeschränkte API-Anfragen zuzugreifen, muss ein Sitzungstoken gesetzt sein. Um ein Token festzulegen, müssen Sie über ein gültiges Konto mit dem erforderlichen Benutzernamen und Passwort oder über ein API-Token verfügen. Klicken Sie auf die Anmelden Schaltfläche oben rechts auf dem Bildschirm und geben Sie Ihren Benutzernamen und Ihr Passwort ein oder stellen Sie ein API-Token bereit. Nachdem Sie auf die Anmelden Schaltfläche geklickt haben, wird eine Anmeldeanfrage an die API gesendet, um ein gültiges Sitzungstoken abzurufen. Dieses Token wird dann verwendet, um alle API-Anfragen zu validieren, die Sie in dieser Sitzung ausführen möchten.

Um eine Anfrage an die API zu senden, klicken Sie auf eine Gruppe. Die Gruppe wird sich erweitern, um die verfügbaren Anfragen aufzulisten. Klicken Sie erneut auf die gewünschte Anfrage. Ein Bereich wird sich erweitern und die Anfragedetails anzeigen.

• Die Antworttext, falls vorhanden, wird zuerst zusammen mit der Antwort angezeigt Content-Type.
• Die Anfrageparameter, erforderliche und/oder optionale, werden als Nächstes zusammen mit der Anfrage detailliert dargestellt Content-Type, falls erforderlich.
• Erwartete Antwortmeldungen werden dann aufgelistet.
• Um die Anfrage auszuführen, füllen Sie die erforderlichen Parameter aus. Wenn der Anfragetext detailliert ist, wird durch Klicken auf den Text im Modell Fenster das Parameterfenster mit dem Text vorab ausgefüllt.
• Sobald alle erforderlichen Parameter festgelegt wurden, wird durch Klicken auf die Ausprobieren Schaltfläche die Anfrage ausgeführt.
• Unterhalb der Schaltfläche werden vier Bereiche angezeigt:

  • Der erste zeigt die vollständige Anfrage-URL.
  • Der zweite zeigt die Antworttext.
  • Der dritte zeigt den Antwortcode.
  • Der vierte zeigt die Antwort-Header.