API-Referenz

Diese Referenz wird aus der OpenAPI-Spezifikation gebaut, die auch die Schnittstelle selbst beschreibt. Was hier steht, steht dort, und umgekehrt. Die Beschreibungen der Felder sind englisch, wie in der Spezifikation.

Basis-URL

https://api.flavoso.com/v1

Anmeldung

Jede Anfrage trägt Authorization: Bearer <access_token>. Wie du an ein Token kommst, steht unter Authentifizierung, zum Ausprobieren reicht ein Test-Token.

Spezifikation

Die ganze Schnittstelle als OpenAPI 3.1 unter https://api.flavoso.com/v1/openapi.json, als Postman-Sammlung unter https://api.flavoso.com/v1/postman.json. Beide ohne Anmeldung.

Verbindung

Die Verbindung zwischen deiner App und einem Betrieb. GET /me ist der erste Aufruf jeder Anbindung: welcher Betrieb, welche Rechte, Test oder echt (livemode), welcher Tarif. DELETE /connection trennt die Verbindung von deiner Seite aus.

• get/meRetrieve the connection, its app and its restaurant
• delete/connectionDisconnect your app from the restaurant

Bestellungen

Bestellungen lesen, annehmen, ablehnen, stornieren, weiterschalten und mit eigener Kennung übernehmen. Der Lebenslauf einer Bestellung steht unter Bestellablauf, die Übernahme in eine Kasse unter Kassenanbindung.

• get/ordersList orders
• get/orders/{id}Retrieve an order
• post/orders/{id}/acceptAccept an order
• post/orders/{id}/rejectReject an order
• post/orders/{id}/cancelCancel an order
• post/orders/{id}/statusAdvance an order
• post/orders/{id}/acknowledgeAcknowledge an order

Speisekarte

Die ganze Karte lesen, mit PUT /menu in einem Aufruf abgleichen, Ausverkauft melden und einzelne Kategorien, Gerichte, Optionsgruppen und Optionen anlegen, ändern und löschen. Mehr dazu unter Speisekarte abgleichen.

• get/menuRetrieve the full menu
• put/menuSync the whole menu from your system
• post/menu/availabilityMark many products and options sold out or available
• get/menu/categoriesList categories
• post/menu/categoriesCreate a category
• get/menu/categories/{id}Retrieve a category
• patch/menu/categories/{id}Update a category
• delete/menu/categories/{id}Delete a category
• get/menu/productsList products
• post/menu/productsCreate a product
• get/menu/products/{id}Retrieve a product
• patch/menu/products/{id}Update a product
• delete/menu/products/{id}Delete a product
• get/menu/option-groupsList option groups
• post/menu/option-groupsCreate an option group
• get/menu/option-groups/{id}Retrieve an option group
• patch/menu/option-groups/{id}Update an option group
• delete/menu/option-groups/{id}Delete an option group
• post/menu/option-groups/{id}/optionsAdd an option to an option group
• get/menu/optionsList options
• get/menu/options/{id}Retrieve an option
• patch/menu/options/{id}Update an option
• delete/menu/options/{id}Delete an option

Betrieb

Öffnungsstatus, Öffnungs- und Lieferzeiten, Sondertage, Vorlaufzeiten, Bestellarten und die Pause der Bestellannahme.

• get/storeRetrieve the store
• patch/storeChange lead times, pre-orders and order types
• get/store/hoursRetrieve opening and delivery hours
• put/store/hoursReplace opening and/or delivery hours
• get/store/closuresList special days
• post/store/closuresCreate or replace a special day
• delete/store/closures/{date}Delete a special day
• post/store/pausePause online ordering
• post/store/resumeResume online ordering

Tische und Bereiche

Die Tische und Bereiche des Betriebs, etwa um Reservierungen einem Tisch zuzuordnen. Nur lesen, mit store:read oder reservations:read. Der Schlüssel im QR-Code eines Tisches steht nie darin.

• get/tablesList tables
• get/areasList areas

Reservierungen

Reservierungen lesen, freie Zeiten abfragen, anlegen, ändern und durch ihre Stände führen. Ab dem Tarif Pro. Mehr dazu unter Reservierungen.

• get/reservationsList reservations
• post/reservationsCreate a reservation
• get/reservations/availabilityFree reservation times of a day
• get/reservations/{id}Retrieve a reservation
• patch/reservations/{id}Change a reservation
• post/reservations/{id}/statusSet a reservation's status

Berichte

Umsätze je Tag, Woche oder Monat und Verkaufszahlen je Gericht, nach denselben Regeln wie die Zahlen im Dashboard. Mehr dazu unter Berichte.

• get/reports/salesSales report
• get/reports/productsProduct sales report

Ereignisse

Dieselben Ereignisse, die Webhooks zustellen, zum Abholen: für Kassen ohne öffentliche Adresse und zum Nachholen nach einem Ausfall. Mehr dazu unter Ereignisse abrufen.

• get/eventsList events
• get/events/{id}Retrieve an event

OAuth

Die Endpunkte der Anmeldung: Autorisierung im Browser, Token-Tausch, Widerruf und Metadaten. Die Autorisierung ist eine Seite unter https://app.flavoso.com/oauth/authorize, denn dort meldet sich der Inhaber an; Token-Tausch, Widerruf und Metadaten liegen auf https://api.flavoso.com, aber nicht unter /v1. Der Ablauf Schritt für Schritt steht unter Authentifizierung.

• get/oauth/authorizeAsk an owner to connect your app
• post/oauth/tokenExchange a code or a refresh token for tokens
• post/oauth/revokeRevoke a token
• get/.well-known/oauth-authorization-serverAuthorization server metadata