API-Überblick
Die Veridien-API ist eine REST-Schnittstelle zu den Daten Ihrer Unterkunft: Verfügbarkeit und Raten, Gäste und Treueprogramm, Buchungen und Gastkonten. Es ist dieselbe Engine, die Veridiens eigene Buchungsabläufe antreibt, offengelegt, damit Sie darauf eine eigene Buchungsmaschine, eine mobile Gast-App, eine Treueprogramm-Anbindung oder beliebige Back-Office-Automatisierung aufbauen können.
Es ist eine gewöhnliche HTTP/JSON-API. Sie authentifizieren sich mit einem API-Schlüssel, senden und empfangen JSON und verlassen sich auf die Standard-Statuscodes. Alles ist auf eine einzelne Unterkunft begrenzt: Ein Schlüssel kann immer nur die Daten der Unterkunft lesen oder ändern, zu der er gehört.
Für echte Anwendungen gebaut
Diese API steuert den produktiven Buchungs- und Treueablauf von Veridien-Unterkünften von Anfang bis Ende: Verfügbarkeit suchen, Bestand blockieren, einen Gast registrieren, eine Reservierung mit Zahlung bestätigen, Gebühren auf das Gastkonto buchen und Treuepunkte sammeln oder einlösen. Folgen Sie dem Schnellstart, um diesen ganzen Ablauf selbst durchzuspielen.
Jede Anfrage geht an eine einzige versionierte Basis-URL:
https://veridien.app/api/v1Jeder Pfad in dieser Referenz ist relativ zu dieser Basis. Die Statusprüfung ist zum Beispiel https://veridien.app/api/v1/health.
Anfragen authentifizieren sich mit einem Bearer-API-Schlüssel im Authorization-Header:
Authorization: Bearer vrdn_live_xxxxxxxxxxxxxxxxxxxxJeder Schlüssel ist an eine Unterkunft gebunden und trägt eine Menge von Scopes, die bestimmen, welche Endpunkte er aufrufen darf. Schlüssel erstellen und verwalten Sie im Dashboard unter Einstellungen → API-Schlüssel. Die öffentlichen Meta-Endpunkte (/health, /openapi.json) brauchen keinen Schlüssel, alles andere schon.
Unter Authentifizierung finden Sie das Schlüsselformat, die vollständige Scope-Liste und ein funktionierendes Beispiel.
- JSON rein, JSON raus. Senden Sie
Content-Type: application/jsonbei Anfragen mit einem Body. Feldnamen sindsnake_case(room_type_id,check_in_date). - Geld sind Zeichenketten. Beträge sind Dezimalzeichenketten mit zwei Nachkommastellen (
"249.00"), damit keine Fließkomma-Rundungen entstehen. Die Währung ist ein dreistelliger ISO-Code. - Datumsangaben sind Zeichenketten. Kalendertage stehen als
YYYY-MM-DD. Zeitstempel sind ISO 8601 (2026-06-19T08:30:00.000Z). - Fehler sind einheitlich. Jeder Fehlschlag liefert dieselbe
error-Hülle mit einem maschinenlesbarencodeund einerrequest_id. - Wiederholungen sind sicher. Ändernde Anfragen akzeptieren einen
Idempotency-Key, sodass eine Wiederholung nie doppelt belastet oder doppelt bucht.
Die vollständigen Regeln stehen in Konventionen.
| Bereich | Endpunkte |
|---|---|
| Katalog | Angaben zur Unterkunft, Zimmertypen, Verfügbarkeit und Raten mit Sichtbarkeitsregeln. Siehe Unterkunft und Katalog. |
| Angebote | Öffentliche Ratenpläne und Pakete auflisten und einen Promo-Code prüfen, bevor Sie einen Preis nennen. Siehe Angebote und Promo-Codes. |
| Gäste | Einen Gast registrieren oder verknüpfen, Profile lesen und aktualisieren, den Treuestand lesen, Punkte einlösen. Siehe Gäste und Treueprogramm. |
| Reservierungen | Bestand blockieren, einen Hold in eine bezahlte Reservierung überführen, Reservierungen auflisten und lesen, stornieren. Siehe Reservierungen. |
| Gastkonten | Das Gastkonto einer Reservierung lesen und Gebühren darauf buchen. Siehe Gastkonten. |
Die API ist im Pfad versioniert (/api/v1). Nicht abwärtskompatible Änderungen erscheinen unter einer neuen Version, additive Änderungen (neue Endpunkte, neue optionale Felder) passieren innerhalb von v1. Behandeln Sie unbekannte Antwortfelder als Ergänzung und ignorieren Sie sie, statt einen Fehler auszulösen.
Eine maschinenlesbare OpenAPI-3.1-Beschreibung jedes Endpunkts wird ohne Authentifizierung ausgeliefert unter:
GET https://veridien.app/api/v1/openapi.jsonNutzen Sie sie, um typisierte Clients zu erzeugen oder genau zu prüfen, welche Endpunkte und Strukturen ausgeliefert sind. Sie ist die Quelle der Wahrheit und entspricht immer der laufenden API.