> 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/fur-entwickler/rest-api.md).

# REST-API

## REST-API

Überblick über die BuildingPro Suites REST-API Die BuildingPro Suites REST-API ermöglicht den einheitlichen Zugriff auf Ressourcen und Daten einer BuildingPro Suites-Umgebung. Die Beschreibung der API liegt im weit verbreiteten [OpenAPI](https://www.openapis.org/) Format vor und kann daher auf vielfältige Weise wiederverwendet werden.

Wie Sie einen KI-Client mit unterstützten BuildingPro Suites-Tools verbinden, erfahren Sie unter [MCP](https://docs.buildings.ability.abb/collection/german/fur-entwickler/mcp.md).

[![](https://api.eliona.io/favicon-32x32.png)BuildingPro Suites API](https://dev.api-doc.buildings.ability.abb/)

Das [BuildingPro Suites App SDK](https://doc.eliona.io/collection/referenzen/app-sdk) stellt vorgefertigte Bibliotheken für verschiedene Programmiersprachen bereit, um über die API auf BuildingPro Suites zuzugreifen.

### Zugriff und Authentifizierung

Die BuildingPro Suites API ist über den URL-Pfad `/api/v2`erreichbar. Lautet die URL für BuildingPro Suites beispielsweise `https://my.eliona.domain`, ist die API über folgende URL erreichbar:

> `https://my.eliona.domain/api/v2`

Für die Authentifizierung wird ein API-Schlüssel verwendet. Dieser wird vom BuildingPro Suites-Administrator für jede Anwendung ausgestellt und kann ein Ablaufdatum haben. Für seine Erstellung muss bekannt sein, welche API-Endpunkte benötigt werden und ob Lese- oder Schreibzugriff gewährt werden soll. Der API-Schlüssel muss im HTTP-Header des Aufrufs wie folgt angegeben werden: `X-Api-Key`:

```
GET https://my.eliona.domain/api/v2/assets/158
X-Api-Key: {{key}}
```

#### **Postman-Sammlung** mit Beispielen

Für einfache API-Tests steht eine Postman-Sammlung mit mehreren Beispielanfragen zur Verfügung. Sie können die Datei `postman_collection.json` über die folgende URL direkt in Postman importieren. Aktualisieren Sie vor der Verwendung der Sammlung die Variablen `api-server` und `read-write-token` so, dass sie Ihrer Umgebung entsprechen.

> <https://raw.githubusercontent.com/eliona-smart-building-assistant/eliona-api/refs/heads/main/examples/postman-collection.json>

### Clients für den API-Zugriff

**Clients für verschiedene Programmiersprachen**

Mithilfe der OpenAPI-Beschreibung der Schnittstelle können mit [OpenAPI-Generatoren](https://openapi-generator.tech/docs/generators)passende Clients für eine Vielzahl von Programmiersprachen erstellt werden. Für die Generierung stehen verschiedene Methoden zur Verfügung. Es wird empfohlen, das bereitgestellte Docker-Image zu verwenden. Dabei wird auf die neueste Version der OpenAPI-Beschreibung verwiesen:

> <https://raw.githubusercontent.com/eliona-smart-building-assistant/eliona-api/main/openapi.yaml>

Hier sehen Sie einen Beispielaufruf zum Generieren eines Clients für die Programmiersprache Go.

{% code lineNumbers="true" %}

```bash
docker run --rm \
     -v "${PWD}:/local" \
     openapitools/openapi-generator-cli:v6.2.1 generate \
     -g go \
     -i [https://raw.githubusercontent.com/eliona-smart-building-assistant/eliona-api/main/openapi.yaml](https://raw.githubusercontent.com/eliona-smart-building-assistant/eliona-api/main/openapi.yaml) \
     -o /local \
     --additional-properties="packageName=api"
```

{% endcode %}

Für die Programmiersprachen Go und Python wird ein Client fortlaufend aktualisiert und über GitHub bereitgestellt.

{% embed url="<https://github.com/eliona-smart-building-assistant/python-eliona-api-client>" %}
Python-Client für die BuildingPro Suites API
{% endembed %}

{% embed url="<https://github.com/eliona-smart-building-assistant/go-eliona-api-client>" %}
Go-Client für die BuildingPro Suites API
{% endembed %}

Postman: API-Beschreibung importieren

Die OpenAPI-Beschreibung der BuildingPro Suites REST-Schnittstelle kann in Postman importiert werden. Dadurch stehen alle Endpunkte für Abfragen zur Verfügung. Importieren Sie dazu die folgende URL in Postman:

> <https://raw.githubusercontent.com/eliona-smart-building-assistant/eliona-api/main/openapi.yaml>

<figure><img src="https://1888287146-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FB9s2DNtIvhBdrJ64xR9g%2Fuploads%2Fy06Xa74cDM69ZY7u8yJR%2Fimage.png?alt=media&#x26;token=e486405a-9a8e-4f83-ae20-02901d94af16" alt=""><figcaption></figcaption></figure>

Import-URL für den Workspace Nach dem Import der OpenAPI-Datei stehen alle Endpunkte zur Verfügung. Um die API zu verwenden, muss der API-Schlüssel im Abschnitt "Autorisierung" und die jeweilige Basis-URL unter "Variablen" eingetragen werden.

#### Mock für API-Tests

Zum Testen der API ist ein entsprechendes BuildingPro Suites-Mock verfügbar. Dieses kann unabhängig von einer vollständigen BuildingPro Suites-Umgebung verwendet werden. Das Mock stellt eine vollständige API-Implementierung und eine vereinfachte BuildingPro Suites-Datenbank in einem Docker-Netzwerk bereit. Die passende `docker-compose.yml` und die Datenbankdefinition werden über GitHub bereitgestellt:

{% embed url="<https://github.com/eliona-smart-building-assistant/eliona-mock>" %}
BuildingPro Suites-Mock
{% endembed %}


---

# 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.buildings.ability.abb/collection/german/fur-entwickler/rest-api.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.
