> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.anex.is/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API Seitenreferenz

> Alle Felder und Einstellungen der REST-API-Komponente: Aktivierung, Zugangsdaten, Scopes und Schnittstellendokumentation.

Diese Seite dokumentiert alle Felder und Einstellungen der REST-API-Komponente. Du erreichst die Einstellungen, indem du im Mandant-Dashboard im Bereich **Allgemein** auf **Komponenten** klickst und die gewünschte REST-API-Komponente auswählst.

Die REST-API-Komponente stellt eine Schnittstelle bereit, über die externe Anwendungen Ressourcen in ROOMS! (dem zentralen PMS) programmatisch abfragen und bearbeiten können. Jede Komponente erhält eigene Zugangsdaten und konfigurierbare Zugriffsrechte (Scopes).

## Felder

| Feld                   | Gültige Werte                     | Hinweise                                                                                                                                                     |
| ---------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Art der Komponente** | Alle verfügbaren Komponententypen | Wird nur beim Erstellen angezeigt. Für die REST API muss „REST API" ausgewählt werden. Nach dem Erstellen ist dieses Feld nicht mehr sichtbar.               |
| **Aktiv**              | Ja, Nein                          | Bei „Ja" ist die Komponente aktiv und kann genutzt werden. Bei „Nein" ist die Komponente inaktiv und steht nicht zur Verfügung.                              |
| **Name**               | Freitext                          | Bezeichnung für die Komponente. Dient bei mehreren Komponenten desselben Typs zur Unterscheidung in der Oberfläche.                                          |
| **Benutzername**       | Automatisch generiert             | Benutzername für die Basic Authentication der Schnittstelle. Wird erst nach dem erstmaligen Speichern angezeigt. Vom System generiert und nicht veränderbar. |
| **Passwort**           | Automatisch generiert             | Passwort für die Basic Authentication der Schnittstelle. Wird erst nach dem erstmaligen Speichern angezeigt. Vom System generiert und nicht veränderbar.     |

### Scopes

Scopes legen fest, auf welche Daten mit welchen Zugriffsrechten zugegriffen werden kann.

| Scope              | Berechtigung     | Hinweise                        |
| ------------------ | ---------------- | ------------------------------- |
| **Gäste**          | Lesen, Schreiben | Zugriff auf Gästedaten.         |
| **Reservierungen** | Lesen, Schreiben | Zugriff auf Reservierungsdaten. |
| **Extras**         | Lesen, Schreiben | Derzeit nicht implementiert.    |
| **Zimmer**         | Lesen, Schreiben | Derzeit nicht implementiert.    |

## Abhängigkeiten

* Das [Modul REST API](/de/mandants/modules/rest-api) muss aktiviert sein, bevor du die Komponente erstellen kannst.
* **Benutzername** und **Passwort** werden erst nach dem erstmaligen Speichern angezeigt. Vor dem ersten Speichern sind die Zugangsdaten nicht verfügbar.

## Logs

Über den Menüpunkt **Logs** kannst du sämtliche Ereignisse der Komponente einsehen. Die Logs enthalten Datum und Uhrzeit des Ereignisses, die Ausführungsdauer, den Status (erfolgreich oder fehlgeschlagen), die Art des Log-Eintrages sowie die eingehend und ausgehend gesendeten Daten. Die Logs sind vorwiegend dann relevant, wenn Probleme mit der Schnittstelle analysiert werden müssen.

## Schnittstellendokumentation

Die aktuelle Schnittstellendokumentation findest du unter: `https://api.cloud.anex.is/api/rest/docs/`

Beachte, dass sämtliche Aufrufe im Produktivsystem stattfinden. Führe Aufrufe mit Bedacht durch.

## Aktionen

| Aktion                      | Beschreibung                                                                                        |
| --------------------------- | --------------------------------------------------------------------------------------------------- |
| **Speichern**               | Speichert die aktuellen Einstellungen. Die Komponente bleibt geöffnet.                              |
| **Speichern und schließen** | Speichert die Einstellungen und schließt die Komponente. Du kehrst zur Komponentenübersicht zurück. |

## Verwandte Artikel

* [Die REST API einrichten](./setup-rest-api) -- Voraussetzungen und Einrichtungsschritte
* [Externe Systeme Seitenreferenz](../external-systems) -- Übersicht aller externen Systeme