> For the complete documentation index, see [llms.txt](https://docs.exoclick.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.exoclick.com/api/de/exoclick-offentliche-api/api-manual-interface.md).

# API-Schnittstelle

Die [API-Schnittstelle](https://api.exoclick.com/v2/docs/) 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**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.exoclick.com/api/de/exoclick-offentliche-api/api-manual-interface.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
