Book-API version:1.2

Situation

Mit der API lässt sich der Reservationsprozess komplett nachbilden, beispielsweise lässt sich damit ein eigenes Reservationsfenster programmieren.

1. Initialisieren

Im ersten Schritt initialisiert man den Reservationsprozess mit der Methode initReservation. Die Rückgabe beinhaltet den request_hash, der für alle weiter API-Calls dieser Reservation benötigt wird. Des Weiteren beinhaltet die Rückgabe Informationen zum Restaurant (Name, Adresse, etc.) sowie die Essenszeiten der ganzen Woche.

2. Raum

Für Restaurants mit nur einem Raum kann dieser Schritt übersprungen werden!
Der Gast wählt den Raum. Dieser wird mit der Methode setRoom der API übermittelt.

3. Tisch

Sobald der Gast Datum, Zeit und Anzahl Personen bestimmt hat, muss die Methode setTable aufgerufen werden, um zu überprüfen, ob zu diesem Zeitpunkt überhaupt eine Reservation möglich ist.

4. Auswahl / Kommentar

In der Antwort der Initialisierung ist bestimmt, ob das Restaurant einen Kommentar erlaubt und ob es eine Auswahl gibt. Dieser Schritt muss nur gemacht werden, wenn ein Kommentarfenster angeboten wird oder die ausgewählte Zeit/Datum sich in der Auswahl Zeit/Datum befindet. Mit der Methode setChoice kann die Auswahl und der Kommentar gesetzt werden.

5. Gast

Danach gibt der Gast seine Angaben (Name, Vorname, E-Mail und Mobile-Nr) an. Mit der Methode setGuest werden diese Daten der API übermittelt. Ist der Gast schon bei forAtable registriert, wird die Reservation automatisch ausgelöst. Ist der Gast unbekannt oder ist er schon mit einer anderen Mobile-Nr oder E-Mail registriert, wird dem Gast eine SMS mit einem vierstelligen Code gesendet.

6. Code überprüfen

Der per SMS erhaltene Code muss vom Gast eingeben werden und dann mit der Methode verifyCode der API übermittelt werden. Ist der Code korrekt wird die Reservation ausgelöst.

Situation

Datum, Zeit und Anzahl Personen werden auf der Seite des Gastronomen erfasst – in der Regel über ein Webformular.
Das Reservationsfenster wird dann per POST Request aufgerufen (mitgegeben wird Datum, Zeit und Personenanzahl) und der Gast landet im Reservationsfenster an der entsprechenden Stelle, von wo er den Reservationsprozess fortsetzen kann.

1. Restaurant Information

Mit der API-Methode getRestaurantInfo lassen sich die Restaurant relevanten Informationen beziehen.

2. Ins Reservationsfenster springen

Die Daten müssen per POST Request dem Reservationsfenster übermittelt werden. Das sollte in einem neuen Fenster geschehen. Der Gast befindet sich danach im Reservationsfenster, also auf der Domain foratable.com.
Dies ist unter der Pseudo API-Methode Direct beschrieben und kann dort getestet werden.