Toast es uno de los sistemas de punto de venta más comunes en América del Norte. En este artículo, explicaremos cómo configurar la integración API entre su sistema Toast y OptiSigns.
- Paso 1: Preparación
- Paso 2: Autenticación en la API de Toast
- Paso 3: Llamar a la API para obtener los datos requeridos de Toast
- Paso 4: Construir el DMB Designer con OptiSync
Toast proporciona una API para que los usuarios integren datos de POS con otros sistemas. Con OptiSync, construir menús digitales que se actualizan automáticamente desde los datos de su API de Toast es simple.
La API de Toast requiere un token de autenticación generado dinámicamente que debe suministrarse con cada llamada a la API, a diferencia de muchos otros sistemas POS que utilizan una clave API estática. Esto añade cierta complejidad a la integración que otros sistemas POS no tienen. Sin embargo, usando la solicitud API de OptiSigns y OptiSync, estas complejidades adicionales no son ningún problema.
En este artículo, proporcionaremos una guía paso a paso sobre cómo integrar su API de Toast usando la solicitud API de OptiSigns, y cómo crear un DMB usando OptiSync. A continuación se muestran los pasos de alto nivel que seguiremos:
1. Obtener la información requerida del portal de Toast
2. Obtener el Token de Autenticación de Toast (Dentro del paso de Pre-Solicitud)
3. Llamar a la API para obtener los datos requeridos de Toast
4. Usar los datos de la API de Toast para construir DMB en el diseñador con OptiSync
Paso 1: Preparación
Para comenzar con la integración de una API de Toast con OptiSigns, necesitamos la siguiente información del sistema Toast:
- toast-api-hostname
- clientId
- clientSecret
- userAccessType
Consulte la documentación de Toast aquí para obtener más detalles.
| NOTA |
| Para poder usar la API de Toast para leer datos, esto requiere acceso Toast Standard API. Esto generalmente conlleva un cargo adicional (a Toast) de $25/mes por ubicación. |
Paso 2: Autenticación para la API de Toast
Para la autenticación de la API de Toast, primero necesitaremos pasar la solicitud POST para obtener el token de autenticación. El token de autenticación se usa luego para pasar en la solicitud de API para obtener los datos de los menús, pedidos, etc. de Toast.
Este proceso de autenticación se manejará usando el procesamiento de Pre-solicitud con la solicitud API de OptiSigns. Para obtener más información sobre el procesamiento de Pre-solicitud y las solicitudes API en general, consulte aquí.
En la etapa de procesamiento de Pre-solicitud, la API de OptiSigns llama a la API de autenticación para obtener el token necesario, y lo establece en el contexto de la solicitud de API.
En este ejemplo, el token se establece en la variable de contexto "authorization". Cuando se realiza la solicitud de API, podrá usar el token de autenticación. A continuación se muestra una captura de pantalla de este ejemplo en la práctica.
Use este fragmento de código (con los datos obtenidos anteriormente completando las "xxx") para
const body = {
"clientId": "xxx",
"clientSecret": "xxx",
"userAccessType": "xxx"
};
const {data, headers} = await os.postRequest("https://[toast-api-hostname]/authentication/v1/authentication/login", body );
const token = os.getValue(data.token.accessToken);
os.context.set("authorization", os.getValue(token));
Paso 3: Llamar a la API para obtener los datos requeridos de Toast
Ahora usaremos el token de autorización que recibimos en el procesamiento de Pre-solicitud y lo pasaremos al encabezado de la llamada API real.
En la pestaña Encabezado, cree dos parámetros con los siguientes valores:
authorization Bearer {{authorization}}
Toast-Restaurant-External-ID
Puede obtener el valor de Toast-Restaurant-External-ID desde el Portal de Toast. Este es el ID del restaurante específico del cual desea obtener datos.
Ahora coloque la URL de API deseada desde la cual desea obtener datos. En este ejemplo hemos usado la siguiente API para obtener los menús
La solicitud final se verá algo así:
Puede habilitar esta solicitud y guardar la API. Haga clic en Ejecutar Prueba.
Debería recibir una respuesta (200 OK), con datos que regresan de la API. Esto significa que la solicitud de API se ha comunicado exitosamente con Toast y está transfiriendo datos.
Paso 4: Construir Menú Digital en Designer con OptiSync
Ahora que su fuente de datos de solicitud API está lista para usar, puede construir su DMB usando Designer con OptiSync. OptiSync le permite mapear los datos de la API a un elemento en el diseñador, ya sea texto o imágenes. Usando Repetidores, estos datos se pueden usar para construir menús de múltiples elementos, y también puede definir cómo le gustaría manejar los artículos agotados, especiales y más.
Para una guía paso a paso y más ejemplos, consulte nuestro artículo sobre Construir Menús Digitales Usando OptiSync.
¡Eso es todo!
Ha recuperado exitosamente los datos de Toast y los ha mostrado en las pantallas usando OptiSigns.