Referencia de la API

Esta referencia se genera a partir de la especificación OpenAPI, que también describe la propia API. Lo que está aquí está allí, y al revés. Las descripciones de los campos están en inglés, como en la especificación.

URL base

https://api.flavoso.com/v1

Autenticación

Cada solicitud lleva Authorization: Bearer <access_token>. En Autenticación se explica cómo conseguir un token; para probar, basta con un token de prueba.

Especificación

Toda la API como OpenAPI 3.1 en https://api.flavoso.com/v1/openapi.json y como colección de Postman en https://api.flavoso.com/v1/postman.json. Ambas sin autenticación.

Conexión

La conexión entre tu app y un negocio. GET /me es la primera llamada de toda integración: qué negocio, qué permisos, prueba o real (livemode), qué plan. DELETE /connection termina la conexión desde tu lado.

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

Pedidos

Leer, aceptar, rechazar, cancelar y hacer avanzar pedidos, y hacerse cargo de ellos con tu propio identificador. El ciclo de vida de un pedido se describe en Flujo de pedidos, y el traspaso a una caja, en Integración con caja.

• 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

Carta

Leer toda la carta, sincronizarla en una sola llamada con PUT /menu, comunicar platos agotados y crear, cambiar y borrar uno a uno categorías, platos, grupos de opciones y opciones. Más en Sincronizar la carta.

• 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

Negocio

Estado de apertura, horarios de apertura y de reparto, días especiales, tiempos de preparación, tipos de pedido y la pausa de los pedidos online.

• 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

Mesas y zonas

Las mesas y zonas del negocio, por ejemplo para asignar una reserva a una mesa. Solo lectura, con store:read o reservations:read. La clave del código QR de una mesa nunca aparece.

• get/tablesList tables
• get/areasList areas

Reservas

Leer reservas, consultar horas libres, crear, cambiar y pasar las reservas de un estado a otro. A partir del plan Pro. Más en Reservas.

• 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

Informes

Ventas por día, semana o mes y ventas por plato, con las mismas reglas que las cifras del panel. Más en Informes.

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

Eventos

Los mismos eventos que entregan los webhooks, para recogerlos: para cajas sin dirección pública y para ponerse al día tras un fallo. Más en Recoger eventos.

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

OAuth

Los endpoints del inicio de sesión: autorización en el navegador, intercambio de tokens, revocación y metadatos. La autorización es una página en https://app.flavoso.com/oauth/authorize, porque allí inicia sesión el propietario; el intercambio de tokens, la revocación y los metadatos están en https://api.flavoso.com, fuera de /v1. El flujo paso a paso está en Autenticación.

• 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