La integración de su punto de venta, sistema de pedidos en línea o plataforma de agregación de pedidos en Fresh KDS es rápida y sencilla con nuestras API, eventos de webhook y opciones de integración local. La columna vertebral de la integración, el envío de pedidos a las pantallas de KDS, solo requiere un par de llamadas a la API. Muchos de nuestros socios tienen encontró el éxito basándose en la lógica de impresión existente para desarrollar una integración sólida en cuestión de semanas.
Para empezar, póngase en contacto con nosotros.
La API Fresh KDS utiliza cuatro conceptos clave:
Los tokens a nivel de marca son la clave del sistema Fresh KDS. Deberás generar un token independiente para cada marca a la que tu sistema envíe pedidos.
No incluyas estos tokens en ningún código. Deberían gestionarse como secretos, por ejemplo, al extraerlos de variables ambientales o almacenes de parámetros. Si tu integración va a ser utilizada por varios clientes, tendrás que implementar la administración de tokens para asociar cada token a la marca Fresh KDS correspondiente.
Se requiere un token válido para cada solicitud a la API de Fresh KDS. Se incluirá en el encabezado de la solicitud:
token de integración x: {ficha}
Una vez que tengas tu token de integración a nivel de marca, podrás realizar solicitudes para obtener información adicional sobre la instalación y la configuración de cada marca. Esta información abarca desde la información básica, como el nombre y la dirección de la ubicación, hasta la información de identificación de un dispositivo individual en una ubicación.
Puedes usar esta información como una forma única de inicializar una configuración para tu integración. O puedes usarla de forma continua como una forma de cuestionar la naturaleza cambiante de la configuración de Fresh KDS de una marca. La ubicación y los ID de los dispositivos son cruciales para el proceso de integración.
Para obtener información sobre una ubicación a través de la API, la ubicación debe tener una suscripción activa a Fresh KDS.
Puedes acceder a información detallada sobre una marca con una sola solicitud:
OBTENGA información sobre /integradores/kds
También hay puntos finales que le permiten solicitar una lista de ubicaciones:
OBTENGA /integradores/información/ubicaciones de KDS
Y puede profundizar más para obtener información sobre dispositivos para una ubicación específica:
OBTENGA /integradores/información de kds/ubicaciones/ {locationId} /dispositivos
YOLos integradores envían pedidos a las pantallas de Fresh KDS a través de la API millones de veces al día. Hemos trabajado arduamente para hacer que esta parte vital del proceso sea lo más simple y fácil posible. Antes de enviar un pedido, tendrás que asegurarte de que tienes token de autenticación y el ubicación e identificadores del dispositivo para el pedido. Solo se necesita una sola solicitud para enviar un pedido a una pantalla de KDS:
POST /integradores/kds-orders
Si bien solo se necesita una solicitud para enviar un pedido, hay algunos parámetros y opciones que merecen una explicación más profunda. En primer lugar, utilizarás los encabezados de tu solicitud para indicar qué ubicación y qué dispositivos necesitan recibir este pedido. Tienes la opción de especificar una lista de identificadores de dispositivos o introducir «todos» para enviar los datos del pedido a todas las pantallas activas de la sucursal.
A continuación, defina un valor único para la propiedad id. Este identificador identificará el «bloque» que aparece en la pantalla del KDS. Si estás enviando el mismo «bloque» a varias pantallas, utilizarás el mismo identificador para cada solicitud. Sin embargo, si un pedido tiene varios «bloques» (por ejemplo, un aperitivo y un plato principal que forman parte del mismo pedido de POS pero que deben prepararse por separado), tendrás que usar una propiedad de identificación distinta para cada plato.
Por último, tendrás que incluir los elementos del menú del pedido. Cada solicitud incluirá una variedad de artículos. Puedes proporcionar detalles sobre un artículo, incluidos los modificadores, las instrucciones especiales, la cantidad y más. Cada artículo debe tener un nombre único ID de línea para que puedas actualizar el artículo más adelante si es necesario.
Basta con enviar esta única solicitud con los detalles del pedido y los artículos del pedido a un dispositivo Fresh KDS para que el pedido llegue a la estación correspondiente de la cocina.
No es raro que los clientes cambien de opinión después de haber hecho un pedido. Afortunadamente, si tu sistema de pedidos permite modificar los pedidos existentes, puedes comunicar estas actualizaciones a la cocina en tiempo real utilizando la ruta de actualización de pedidos de Fresh KDS. De esta forma, la cocina siempre trabaja con la información más reciente.
Para actualizar un pedido, necesitarás conocer la identificación utilizado en la solicitud de creación de pedido original. Este valor se habría devuelto en la respuesta de éxito de la API. También necesitarás conocer los valores de `LineID` utilizados en la solicitud original.
También puede comprobar si el pedido sigue activo en las pantallas de KDS mediante el solicitud de pedido activa:
GET /integrators/kds-orders/active
Una vez que hayas confirmado que el pedido sigue activo, puedes realizar el actualizar solicitud de pedido:
PUT /integradores/kds-orders
Al hacer esta solicitud, tendrás que incluir todos los artículos, cantidades, instrucciones especiales y otros detalles del pedido original. Por ejemplo, si el pedido original contenía dos elementos de menú y vas a añadir un tercero, la solicitud PUT debe incluir un total de tres elementos en la matriz de elementos, los dos primeros con su original ID de línea valores y el tercero con un nuevo `LineId`. Para actualizar un elemento del menú o sus modificadores, basta con incluir el `LineId` original y reemplazar el contenido por la nueva información.
Además de añadir, eliminar y cambiar los elementos del menú, puedes usar la ruta de actualización del pedido para cambiar el tipo de pedido (es decir, cambiar For Here to Go), la hora de recogida o cualquier otra propiedad.
Enviar y actualizar los pedidos son los dos pasos más básicos e importantes para crear su integración con Fresh KDS. Sin embargo, Fresh KDS ofrece mucho más, como la mensajería con los clientes, la comunicación entre pantallas y la funcionalidad virtual. Consulte el soluciones consulte la sección siguiente para obtener más información sobre cómo puede habilitar estas potentes funciones para sus clientes mediante la integración con Fresh KDS.
Fresh KDS no admite de forma nativa el enrutamiento a nivel de categoría o elemento. Fresh KDS admite el enrutamiento por tipo de pedido, lo que significa que cada pantalla de KDS puede activar o desactivar los tipos de pedido que deben mostrarse. Esto permite a los integradores enviar pedidos de todo tipo a todas las pantallas y permite a las ubicaciones configurar qué tipos de pedidos deben aparecer.
El enrutamiento a nivel de categoría o artículo se puede integrar desde el punto de vista del integrador; muchos de nuestros socios lo han hecho con éxito basándose en la lógica de sus impresoras existentes. Si bien el ruta de envío del pedido le permite enviar un pedido a varias pantallas en una sola llamada a la API, esto solo se aplica si los artículos que se envían a cada pantalla son idénticos. Si vas a enviar artículos de un mismo pedido a diferentes pantallas, tendrás que realizar una llamada a la API para cada combinación de artículos. En cada una de estas llamadas a la API, querrás usar la misma identificación por lo que Fresh KDS puede identificar qué «bloques» de cada pantalla están asociados entre sí.
Fresh KDS tiene la capacidad de enviar mensajes a los clientes con información sobre su pedido. Esto función premium está disponible en los Estados Unidos y Canadá a través de mensajes SMS. Hay tres activadores de mensajería opcionales:
Desde la perspectiva del integrador, lo único que se necesita para habilitar esta función es configurar el Número de teléfono y Optar por SMS propiedades cuando enviar un pedido. El Número de teléfono debe enviarse Formato E.164. Si sus clientes han optado por recibir mensajes de texto, configure Optar por SMS en verdadero; de lo contrario, establézcalo en falso. Si Optar por SMS es falso Fresh KDS no enviará mensajes al cliente, incluso si las pantallas están configuradas para hacerlo.
Hay dos tipos de comunicación entre pantallas en Fresh KDS: multicapa y enviar a la siguiente pantalla. Ambos tipos son fáciles de habilitar mediante la API o la integración local.
Transparencia múltiple la comunicación entre pantallas sincroniza las ideas de golpe de objetos y el orden cambia entre varias pantallas. Para que esta función funcione correctamente, las pantallas deben poder identificar qué «bloques» y objetos de esos bloques son iguales. Esto se hace configurando lo mismo identificación propiedad al enrutar «bloques» de orden a diferentes pantallas. Los elementos se comparan mediante los nombres de los elementos del menú y de los modificadores.
Por ejemplo, supongamos que tiene un pedido que contiene una hamburguesa y una ensalada. Realiza tres llamadas a la API para enviar la hamburguesa a la estación de parrilla, la ensalada a la estación de ensaladas y ambos productos a la estación de exposiciones. En cada llamada, estableces el identificador en 12345. Esto permitirá a Fresh KDS identificar el bloque de pedidos como el mismo en las tres pantallas. Si la estación de exposición está configurada para permitir el paso a la parrilla y la estación de ensaladas, cuando el usuario retire el pedido de la exposición, también lo hará de las estaciones de parrilla y ensaladas.
El enviar a la siguiente pantalla La opción puede ser útil en cocinas con un modelo de línea de montaje, por ejemplo, una pizzería donde la primera estación prepara la pizza y la segunda la cocina. La pantalla del KDS de la segunda estación no necesita enterarse del pedido hasta que la pizza esté preparada y entregada desde la primera estación. Como integrador, basta con enviar el pedido únicamente a la pantalla KDS de la primera emisora y dejar que Fresh KDS se encargue del resto.
Fresh KDS incluye una serie de funciones para ayudar a los restaurantes a agilizar el servicio de recogida en la acera. Todas estas funciones están disponibles para los integradores a través de la API.
Lo primero que tendrá que hacer para los pedidos en la acera es establecer el modo propiedad en CurbSide cuando enviar el pedido a Fresh KDS. También querrás incluir el Modelo de vehículo y Color del vehículo propiedades. Estos valores se mostrarán en la vista para llevar de Fresh KDS para ayudar al restaurante a identificar el coche del cliente a su llegada.
A continuación, querrá configurar las notificaciones de llegada. Hay dos métodos para hacerlo: puedes proporcionar una URL de llegada al enviar el pedido o puedes permitir que Fresh KDS genere la URL. A continuación, abordaremos ambos métodos.
Si ya tiene una lógica de llegada de clientes integrada en su plataforma, simplemente puede proporcionar el URL de llegada del cliente valor al enviar el pedido a las pantallas del KDS. Fresh KDS añadirá esta URL a los mensajes de los clientes sobre el pedido recibido y el pedido listo. Nota: La mensajería al cliente es una función premium y la pantalla del KDS que recibe el pedido debe configurarse para enviar mensajes. Puede habilitar esta función sin utilizar la mensajería de Fresh KDS si proporciona la URL directamente a su cliente.
Cuando el cliente haga clic en el enlace del mensaje, tendrás que gestionar el evento y enviar una solicitud al punto final de llegada del cliente:
POST /integradores/notificaciones de kds/llegada del cliente
En la vista para llevar de la pantalla del KDS, esta notificación moverá el pedido a la parte superior de la cola y mostrará el icono de llegada. Para que Fresh KDS aplique la notificación al pedido correcto, tendrás que incluir la misma identificación se utiliza al crear el pedido.
El otro método para habilitar las notificaciones externas es que Fresh KDS genere la URL de llegada, añada esa URL al mensaje del cliente y, a continuación, gestione el evento cuando el cliente hace clic en el enlace. El uso de este método no requiere información adicional por parte del integrador, pero sí requiere la ubicación de KDS para usar la función de mensajería premium. En la configuración de mensajería, la ubicación puede activar la opción «enviar el enlace «Estoy aquí», lo que añadirá automáticamente la URL de llegada del cliente al mensaje.
El punto final de llegada del cliente funcionará para cualquier pedido, incluso si no se ha proporcionado ni generado ninguna URL. Esto significa que puedes crear una integración que no requiera la interacción del cliente para activar la notificación de llegada. Por ejemplo, si tienes funciones de rastreo por GPS en tu plataforma, puedes usarlas para enviar la notificación de llegada cuando el cliente esté cerca del restaurante. También puedes usar el hora límite estimada de llegada para enviar actualizaciones en tiempo real sobre cuándo esperar al cliente:
POST /integradores/notificaciones de kds/actualización de llegada estimada
La hora estimada de llegada, en minutos, aparecerá en el pedido en la vista para llevar de la pantalla del KDS.
Fresh KDS incluye un par de opciones relacionadas con los pedidos de entrega de terceros. La primera es la Fuente de origen propiedad cuando enviar un pedido. Los valores aceptados son DOORDASH, UBEREATS y GRUBHUB. Si se proporciona, este valor se mostrará en el pedido en la vista de KDS para que la cocina sepa de qué servicio de entrega proviene el pedido.
La segunda opción es pasar el Servicio de entrega objeto que incluye las propiedades del nombre del servicio de entrega, el identificador del pedido y el número de teléfono de contacto del conductor. Estos valores se mostrarán en el pedido en la vista de comida para llevar.
El nuevo KDS incluye webhooks para eventos comunes que ocurren en el sistema KDS. Estos eventos en tiempo real permiten a los integradores recibir información sobre el sistema KDS a medida que ocurre. Los webhooks se configuran a nivel de marca en el portal web de Fresh KDS.
Dispositivos
Dispositivo creado: el webhook se activa cada vez que se registra una nueva pantalla de KDS
Dispositivo actualizado: el webhook se activa cada vez que se cambia la información sobre la pantalla del KDS
Dispositivo eliminado: el webhook se activa cada vez que se elimina una pantalla de KDS
Pedidos
Casos de uso
Algunos ejemplos de cómo nuestros socios han aprovechado los webhooks incluyen:
Además de las API en la nube, es posible enviar pedidos a las pantallas de Fresh KDS de la red local de un restaurante. Esto permite a los integradores desarrollar una integración que pueda funcionar en modo «offline» sin conexión a Internet. Consulte el Referencia técnica de integración local para obtener más información.
Hay varias consideraciones a la hora de decidir cómo integrar Fresh KDS:
¿Puedo usar ambos?
Tendrá que elegir un método para enviar los pedidos a las pantallas de KDS, ya sea mediante una API en la nube o de forma local. Sin embargo, si eliges enviar los pedidos a las pantallas de la red local, puedes aumentarlos con las rutas de la API en la nube, siempre que utilices las mismas `identificación` propiedad para identificar correctamente el pedido.
Obtenga más información sobre cómo crear una integración con Fresh KDS.
