Riferimento API

Questo riferimento è costruito dalla specifica OpenAPI che descrive l'API stessa. Ciò che sta qui sta là, e viceversa. Le descrizioni dei campi sono in inglese, come nella specifica.

URL di base

https://api.flavoso.com/v1

Autenticazione

Ogni richiesta porta Authorization: Bearer <access_token>. Come ottenere un token è spiegato in Autenticazione; per provare basta un token di prova.

Specifica

Tutta l'API come OpenAPI 3.1 su https://api.flavoso.com/v1/openapi.json e come raccolta Postman su https://api.flavoso.com/v1/postman.json. Entrambe senza autenticazione.

Collegamento

Il collegamento tra la tua app e un locale. GET /me è la prima chiamata di ogni integrazione: quale locale, quali permessi, prova o reale (livemode), quale piano. DELETE /connection chiude il collegamento dal tuo lato.

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

Ordini

Leggere, accettare, rifiutare, annullare e far avanzare gli ordini, e prenderli in carico con il tuo identificativo. Il ciclo di vita di un ordine è in Flusso degli ordini, il passaggio a una cassa in Integrazione cassa.

• 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

Menu

Leggere tutto il menu, sincronizzarlo in una sola chiamata con PUT /menu, segnalare ciò che è esaurito e creare, modificare ed eliminare categorie, piatti, gruppi di opzioni e opzioni. Di più in Sincronizzare il menu.

• 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

Locale

Stato di apertura, orari di apertura e di consegna, giorni speciali, tempi di preparazione, tipi di ordine e la pausa degli ordini.

• 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

Tavoli e aree

I tavoli e le aree del locale, per esempio per assegnare una prenotazione a un tavolo. Solo lettura, con store:read o reservations:read. La chiave del codice QR di un tavolo non compare mai.

• get/tablesList tables
• get/areasList areas

Prenotazioni

Leggere le prenotazioni, consultare gli orari liberi, creare, modificare e far passare le prenotazioni da uno stato all'altro. Dal piano Pro. Di più in Prenotazioni.

• 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

Report

Fatturato per giorno, settimana o mese e vendite per piatto, con le stesse regole dei numeri della dashboard. Di più in Report.

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

Eventi

Gli stessi eventi consegnati dai webhook, ma da recuperare in autonomia: per le casse senza indirizzo pubblico e per rimettersi in pari dopo un guasto. Di più in Recuperare gli eventi.

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

OAuth

Gli endpoint dell'accesso: autorizzazione nel browser, scambio dei token, revoca e metadati. L'autorizzazione è una pagina su https://app.flavoso.com/oauth/authorize, perché è lì che il titolare accede; scambio dei token, revoca e metadati si trovano su https://api.flavoso.com, fuori da /v1. Il flusso passo per passo è in Autenticazione.

• 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