> For the complete documentation index, see [llms.txt](https://docs.g-iot.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.g-iot.io/de/plattform-benutzerhandbuch/verwaltung/swagger-api-einfuhrung.md).

# Swagger API Einführung

API-Einstellungen können die Aktionen (Erstellen, Lesen, Löschen usw.) einschränken, die basierend auf dem API-Schlüssel ausgeführt werden können. Jeder Schlüssel hat spezifische Berechtigungen, die den Zugriff auf Daten ermöglichen oder einschränken und Updates oder Löschungen verhindern. Dies ist wichtig für die Kommunikation zwischen Computer und stellt sicher, dass jeder Schlüssel nur auf die zugewiesenen Operationen zugreifen kann. Zusätzlich können API-Schlüssel so eingerichtet werden, dass der Zugriff auf bestimmte Gruppen oder Geräte kontrolliert wird, um sicherzustellen, dass nur autorisierte Computer mit diesen Geräten interagieren können. Dies hilft, die unbefugte Nutzung der API zu verhindern.

<figure><img src="https://2648756693-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7MM4qMpFROaIGLQwO80c%2Fuploads%2FKRWVddgG1IOIP52CqSIa%2FAPI%20DE.png?alt=media&amp;token=ed56ab5e-8785-43e8-be21-120ebc2eecfa" alt=""><figcaption><p>Swagger API Einführung</p></figcaption></figure>

## Schritte zum Swagger API

1. Navigieren Sie zum Administrationsmenü:
   * Stellen Sie sicher, dass Sie im Cockpit-Menü sind, und klicken Sie dann auf Verwaltung.
2. Zugriff auf den API-Bereich:
   * Klicken Sie auf API, um automatisch zu Swagger weitergeleitet zu werden.
3. API-Zugang autorisieren:
   * Klicken Sie in Swagger auf die Schaltfläche "Autorisieren".
4. Geben Sie den API-Schlüssel ein:
   * Geben Sie den API-Schlüssel ein, um den Authentifizierungsprozess abzuschließen.

{% hint style="success" %}
**Zugriff auf die API-Dokumentation hier:** [**https://app.gitbook.com/o/DKrl40rifuf7Bl8WIqXK/s/7MM4qMpFROaIGLQwO80c/\~/changes/62/.pdf-datei-zum-herunterladen/technisch.pdf**](/de/.pdf-datei-zum-herunterladen/api-dokumentation.md)
{% endhint %}


---

# 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.g-iot.io/de/plattform-benutzerhandbuch/verwaltung/swagger-api-einfuhrung.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.