Référence de l'API

Cette référence est construite à partir de la spécification OpenAPI qui décrit l'API elle-même. Ce qui figure ici figure là-bas, et inversement. Les descriptions des champs sont en anglais, comme dans la spécification.

URL de base

https://api.flavoso.com/v1

Authentification

Chaque requête porte Authorization: Bearer <access_token>. Comment obtenir un jeton est expliqué sous Authentification ; pour essayer, un jeton de test suffit.

Spécification

Toute l'API en OpenAPI 3.1 sous https://api.flavoso.com/v1/openapi.json, en collection Postman sous https://api.flavoso.com/v1/postman.json. Les deux sans authentification.

Connexion

La connexion entre votre application et un établissement. GET /me est le premier appel de toute intégration : quel établissement, quels droits, test ou réel (livemode), quelle offre. DELETE /connection met fin à la connexion de votre côté.

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

Commandes

Lire, accepter, refuser, annuler et faire avancer les commandes, et les prendre en charge avec votre propre identifiant. Le cycle de vie d'une commande est décrit sous Déroulement des commandes, la reprise dans une caisse sous Intégration caisse.

• 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

Carte

Lire toute la carte, la synchroniser en un appel avec PUT /menu, signaler les ruptures et créer, modifier et supprimer catégories, plats, groupes d'options et options. Plus de détails sous Synchroniser la carte.

• 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

Établissement

Statut d'ouverture, horaires d'ouverture et de livraison, jours particuliers, délais de préparation, modes de commande et mise en pause des commandes.

• 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

Tables et zones

Les tables et les zones de l'établissement, par exemple pour attribuer une réservation à une table. En lecture seule, avec store:read ou reservations:read. La clé du QR code d'une table n'y figure jamais.

• get/tablesList tables
• get/areasList areas

Réservations

Lire les réservations, consulter les créneaux libres, créer, modifier et faire passer les réservations d'un statut à l'autre. À partir de l'offre Pro. Plus de détails sous Réservations.

• 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

Rapports

Chiffre d'affaires par jour, semaine ou mois et ventes par plat, selon les mêmes règles que les chiffres du tableau de bord. Plus de détails sous Rapports.

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

Événements

Les mêmes événements que ceux livrés par webhook, mais récupérés par votre application : pour les caisses sans adresse publique et pour rattraper le retard après une panne. Plus de détails sous Récupérer les événements.

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

OAuth

Les points de terminaison de l'authentification : autorisation dans le navigateur, échange de jetons, révocation et métadonnées. L'autorisation est une page sous https://app.flavoso.com/oauth/authorize, car c'est là que le propriétaire s'identifie ; l'échange de jetons, la révocation et les métadonnées se trouvent sur https://api.flavoso.com, en dehors de /v1. Le déroulement pas à pas est décrit sous Authentification.

• 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