KitchenFlow

REST API

Las claves se limitan a un restaurante y a los permisos seleccionados al crearlas. Envíalas en Authorization: Bearer kf_live_…. No incluyas una clave secreta en una aplicación web pública.

Descargar especificación OpenAPI 3.1

La API permite consultar y gestionar pedidos, menú y mesas con alcances separados. Crear restaurantes y procesar pagos requieren flujos de aprovisionamiento y un proveedor de pagos; esos endpoints aún no están habilitados.

MétodoRutaPermisoDescripción
GET/api/v1/ordersorders:readList tenant orders; accepts limit and status.
POST/api/v1/ordersorders:writeCreate an order with items.
PATCH/api/v1/orders/{id}orders:updateSet status to new, preparing, ready, or completed.
GET/api/v1/menumenu:readList menu items.
POST/api/v1/menumenu:writeCreate a menu item.
PATCH/api/v1/menu/{id}menu:writeUpdate a menu item.
GET/api/v1/restaurantsrestaurants:readRead the restaurant for this key.
GET/api/v1/tablestables:readList restaurant tables.
POST/api/v1/tablestables:writeCreate a restaurant table.
GET/api/v1/analytics/kpisanalytics:readToday's order counts and gross total (UTC).

Explorador interactivo

Autoriza una clave de prueba para enviar solicitudes desde esta documentación. La autorización no se conserva al cerrar o recargar la página.

Cargando documentación interactiva…

Crear una orden

Manda una lista de 1 a 100 productos. Cada elemento necesita nombre, precio no negativo y cantidad entera positiva. Usa el mismo UUID de Idempotency-Key si reintentas enviar esa misma orden.

curl -X POST https://tu-dominio/api/v1/orders \
  -H 'Authorization: Bearer kf_live_TU_CLAVE' \
  -H 'Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Content-Type: application/json' \
  -d '{"type":"dine-in","table":"Mesa 1","items":[{"name":"Hamburguesa","price":18.5,"quantity":2}]}'

La administración de claves está disponible para administradores en GET/POST /api/v1/keys y revocación con DELETE /api/v1/keys/{id}, autenticándose con la sesión Bearer de Supabase. La clave nueva se muestra una sola vez.