Wichtige API-Endpunkte

Wichtige Endpunkte

Die API liest nur und hat drei Endpunkte. Reservierungen, Gäste und Treuekarten lassen sich über die API derzeit weder lesen noch ändern. Felder, Fehlercodes und Beispielantworten stehen in der API-Referenz.

Die Basis-Adresse ist https://platzeo.de/api/v1. {slug} ist der Slug Ihres Restaurants, also der Teil vor .platzeo.de in der Adresse Ihrer Buchungsseite.

Restaurant des Schlüssels

GET /api/v1/restaurants

Liefert eine Liste mit genau einem Eintrag: Slug, Name, Tarif, Primärfarbe und Farbmodus. Berechtigung: api.restaurants.read.

Profil und Öffnungszeiten

GET /api/v1/restaurant/{slug}/info

Liefert Name, Adresse, Telefon und die Öffnungszeiten je Wochentag. Endet eine Schicht nach Mitternacht, steht dort die Uhrzeit des Folgetags, zum Beispiel 17:00–01:00. Ein Tag ohne Schicht heißt Geschlossen, mit ?lang=en Closed; ohne lang gilt die Sprache Ihrer Buchungsseite. cuisine ist immer eine leere Liste: Eine Küchenart lässt sich nicht hinterlegen. Berechtigung: api.restaurants.read.

Freie Zeiten

GET /api/v1/restaurant/{slug}/availability?count=3&partySize=2

Liefert die nächsten freien Zeiten für eine Online-Reservierung aus den kommenden sieben Tagen: genau die Zeiten, die auch Ihre Buchungsseite für diese Personenzahl anbietet. count ist die Zahl der Zeiten (1 bis 10, ohne Angabe 3), partySize die Personenzahl (von 1 bis zur größten Gruppe, die Sie online annehmen, ohne Angabe 2). Berechtigung: api.availability.read.

Jede Zeit hat vier Felder:

• date und time – Tag (JJJJ-MM-TT) und Uhrzeit (HH:MM)
• request – true, wenn eine Buchung für diese Personenzahl eine Anfrage ist, die Sie erst bestätigen müssen
• maxGuests – die größte Personenzahl, die Ihre Buchungsseite zu dieser Zeit noch annimmt

Die Antwort nennt in count und partySize, wofür sie gilt. bookingOpen ist false, wenn Ihr Restaurant gerade keine Online-Reservierungen annimmt.

Ein Wert außerhalb der Grenzen wird mit Status 400 abgelehnt und nie durch einen anderen ersetzt (INVALID_PARAMETER, PARTY_SIZE_TOO_LARGE). Andere Parameter kennt der Endpunkt nicht (UNKNOWN_PARAMETER); ein Datum lässt sich nicht vorgeben.

Fehler

Jeder Fehler ist JSON mit einem deutschen Satz im Feld error und einem festen code: UNAUTHENTICATED (401), FORBIDDEN (403), NOT_FOUND (404), METHOD_NOT_ALLOWED (405), RATE_LIMITED (429) und die drei Codes oben (400).

Reservierungen auf Ihrer Website

Reservierungen nimmt die API nicht an. Dafür binden Sie das JavaScript-Widget, den iFrame oder das WordPress-Plugin ein. Über Ereignisse in Ihrem Restaurant informieren Webhooks.