> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/german-14.2-freezed/dokumentation/einstellungen/api-schlussel.md).

# API-Schlüssel

## API-Schlüssel erstellen

<div data-full-width="true"><figure><img src="/files/nkOCwTcKrdR2bWEUuIXn" alt=""><figcaption></figcaption></figure></div>

1. **Navigieren Sie zu den Einstellungen \[A]**\
   Klicken Sie auf das Zahnradsymbol in der linken Seitenleiste, um die *Einstellungen* zu öffnen.\
   ▷ Das Menü *Einstellungen* wird angezeigt.
2. **API-Schlüssel verwalten \[B]**\
   Klicken Sie in der oberen Menüleiste auf den Reiter *API-Schlüssel*.\
   ▷ Die Seite zur Verwaltung der API-Schlüssel wird geöffnet.
3. **Neuen API-Schlüssel erstellen \[C]**\
   Klicken Sie auf die Schaltfläche **+ API-Schlüssel** in der oberen rechten Ecke.\
   ▷ Ein Formular zur Eingabe der API-Schlüsseldetails wird angezeigt.
4. **Details des API-Schlüssels eingeben**\
   Geben Sie die benötigten Informationen ein:

   ***Name***: Geben Sie einen eindeutigen Namen für den API-Schlüssel an.

   ***Gültigkeitsdatum***: Wählen Sie ein Ablaufdatum aus, falls der Schlüssel zeitlich begrenzt sein soll.

   ◈ Ein abgelaufener API-Schlüssel ist nicht mehr verwendbar und muss erneuert werden, um die   Verbindung zur API aufrechtzuerhalten.
5. **API-Schlüssel erstellen**\
   Klicken Sie auf **Erstellen**, um den neuen API-Schlüssel zu erstellen.\
   ▷ Der neue API-Schlüssel wird in der Liste der API-Schlüssel angezeigt.

{% hint style="danger" %}
API-Schlüssel sollten nur vertrauenswürdigen Personen zur Verfügung gestellt werden, um den Zugriff auf Ihre *Eliona*-Daten zu schützen.
{% endhint %}

## API-Schlüssel Informationen

Auf der Seite der *API-Schlüssel*-Liste können Sie die folgenden Informationen für jeden API-Schlüssel einsehen:

**Name des API-Schlüssels**\
Der Name des API-Schlüssels wird in der Liste angezeigt, um eine eindeutige Identifikation zu ermöglichen.

**Verfallsdatum**\
Das Ablaufdatum des API-Schlüssels wird deutlich sichtbar angezeigt.&#x20;

◈Sobald ein API-Schlüssel abgelaufen ist, kann er nicht mehr verwendet werden, und der Zugriff auf die API ist blockiert.

**Abgelaufen-Status**\
Wenn ein API-Schlüssel abgelaufen ist, wird dies durch eine Warnmeldung auf der rechten Seite neben dem Schlüssel angezeigt. <img src="/files/Ie4PMp9JZMcSn8Be8fLl" alt="" data-size="line">

{% hint style="info" %}
&#x20;Ein abgelaufener API-Schlüssel muss erneuert werden, um die Verbindung zur API wiederherzustellen.
{% endhint %}

**API-Schlüssel kopieren**\
Für jeden Schlüssel steht eine Schaltfläche **Schlüssel kopieren** zur Verfügung, mit der der Schlüssel in die Zwischenablage kopiert werden kann. <img src="/files/bGGXcQWIDYKTBvcTkuiQ" alt="" data-size="line">\
▷ Sie können den kopierten Schlüssel verwenden, um API-Anfragen zu authentifizieren.

**API-Schlüssel löschen**\
Über die Schaltfläche <img src="/files/DcFCLYULy43hzkHpLDOX" alt="" data-size="line"> kann ein nicht mehr benötigter API-Schlüssel entfernt werden.

**Mehr Informationen anzeigen**\
Klicken Sie auf **Mehr Informationen** <img src="/files/4dNHMVcSIx517HIvaZY0" alt="" data-size="line">, um zusätzliche Details zum API-Schlüssel anzuzeigen.<br>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.buildings.ability.abb/collection/german-14.2-freezed/dokumentation/einstellungen/api-schlussel.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.