Zum Hauptinhalt springen

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.

Die REST-API-Komponente stellt eine Schnittstelle bereit, über die externe Anwendungen Ressourcen in ROOMS! (dem zentralen PMS) programmatisch abfragen und bearbeiten können. Dieser Artikel beschreibt, welche Voraussetzungen nötig sind und wie du die REST API Schritt für Schritt einrichtest.

​
Voraussetzungen

​
Schritte

  1. Klicke im Mandant-Dashboard im Bereich Allgemein auf Komponenten.
  2. Klicke auf Neu, um eine neue Komponente zu erstellen.
  3. Wähle bei Art der Komponente den Wert „REST API” aus.
  4. Vergib einen Namen für die Komponente (z. B. „REST API Website” oder „REST API Channel Manager”).
  5. Konfiguriere die Scopes, um festzulegen, auf welche Daten mit welchen Zugriffsrechten zugegriffen werden kann. Aktiviere die benötigten Berechtigungen (Lesen und/oder Schreiben) für die jeweiligen Datenbereiche (Gäste, Reservierungen).
  6. Setze das Feld Aktiv auf „Ja”.
  7. Klicke auf Speichern oder Speichern und schließen, um die Einstellungen zu bestätigen.
  8. Nach dem Speichern werden Benutzername und Passwort für die Basic Authentication angezeigt. Gib diese Zugangsdaten an den Hersteller der externen Anwendung weiter.

​
Tipps

  • Lege pro Anwendungsfall eine separate REST-API-Komponente an und benenne die Komponente entsprechend (z. B. „REST API Website”, „REST API Channel Manager”). So kannst du Fehler leichter zuordnen und bei Bedarf einzelne Zugänge deaktivieren, ohne andere Anwendungen zu beeinflussen.
  • Die REST-API-Komponente ermöglicht umfangreiche Datenzugriffe, auch auf sensible Daten. Prüfe vor der Aktivierung den Datenschutz-Aspekt mit den Anwendungsherstellern bzw. Unternehmen, die auf die Daten zugreifen. Für etwaige Änderungen oder Schäden durch die Benutzung der Schnittstelle wird nicht gehaftet.
  • Über den Menüpunkt Logs in der Komponente kannst du sämtliche Ereignisse einsehen, falls es Probleme mit der Schnittstelle geben sollte.
  • Die aktuelle Schnittstellendokumentation findest du unter: https://api.cloud.anex.is/api/rest/docs/. Beachte, dass Aufrufe dort im Produktivsystem stattfinden.

​
Verwandte Artikel