How to use Toast API data with OptiSigns

Toast est l'un des systèmes de point de vente les plus courants en Amérique du Nord. Dans cet article, nous expliquerons comment configurer l'intégration API entre votre système Toast et OptiSigns.

• Étape 1 : Préparation
• Étape 2 : Authentification à l'API Toast
• Étape 3 : Appeler l'API pour obtenir les données requises de Toast
• Étape 4 : Créer le DMB Designer avec OptiSync

Toast fournit une API permettant aux utilisateurs d'intégrer les données POS avec d'autres systèmes. Avec OptiSync, créer des menus numériques auto-actualisés à partir des données de votre API Toast est simple.

L'API Toast nécessite un jeton d'authentification généré dynamiquement à fournir avec chaque appel API, contrairement à de nombreux autres systèmes POS qui utilisent une clé API statique. Cela ajoute une certaine complexité à l'intégration que d'autres systèmes POS n'ont pas. Cependant, en utilisant la requête API d'OptiSigns et OptiSync, ces complexités supplémentaires ne posent aucun problème.

Dans cet article, nous fournirons un guide étape par étape sur la façon d'intégrer votre API Toast en utilisant la requête API d'OptiSigns, et comment créer un DMB en utilisant OptiSync. Voici les étapes principales que nous suivrons :

1. Obtenir les informations requises depuis le portail Toast

2. Obtenir le jeton d'authentification de Toast (dans l'étape de pré-requête)

3. Appeler l'API pour obtenir les données requises de Toast

4. Utiliser les données de l'API Toast pour créer un DMB dans le designer avec OptiSync

Étape 1 : Préparation

Pour commencer l'intégration d'une API Toast avec OptiSigns, nous avons besoin des informations suivantes provenant du système Toast :

• toast-api-hostname
• clientId
• clientSecret
• userAccessType

Consultez la documentation de Toast ici pour plus de détails.

Étape 2 : Authentification pour l'API Toast

Pour l'authentification de l'API Toast, nous devrons d'abord passer la requête POST pour obtenir le jeton d'authentification. Le jeton d'authentification est ensuite utilisé pour passer dans la requête API afin d'obtenir les données des menus, commandes, etc. de Toast.

Ce processus d'authentification sera géré en utilisant le traitement pré-requête avec la requête API d'OptiSigns. Pour plus d'informations sur le traitement pré-requête et les requêtes API en général, veuillez consulter ici.

Dans l'étape de traitement pré-requête, l'API d'OptiSigns appelle l'API d'authentification pour obtenir le jeton nécessaire, et le définit dans le contexte de la requête API.

Dans cet exemple, le jeton est défini dans la variable de contexte "authorization". Lorsque la requête API est effectuée, elle pourra utiliser le jeton d'authentification. Voici une capture d'écran de cet exemple en pratique.

Utilisez cet extrait de code (avec les données obtenues précédemment en remplaçant les "xxx") pour

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));

Étape 3 : Appeler l'API pour obtenir les données requises de Toast

Maintenant, nous allons utiliser le jeton d'autorisation que nous avons reçu dans le traitement pré-requête et le passer dans l'en-tête de l'appel API réel.

Dans l'onglet En-tête, créez deux paramètres avec les valeurs suivantes :

authorization Bearer {{authorization}}

Toast-Restaurant-External-ID

Vous pouvez obtenir la valeur Toast-Restaurant-External-ID depuis le portail Toast. Il s'agit de l'identifiant spécifique du restaurant pour lequel vous souhaitez obtenir des données.

Maintenant, entrez l'URL API souhaitée à partir de laquelle vous voulez obtenir des données. Dans cet exemple, nous avons utilisé l'API suivante pour obtenir les menus

• • https://ws-api.toasttab.com/menus/v2/menus

La requête finale ressemblera à quelque chose comme ceci :

Vous pouvez activer cette requête et enregistrer l'API. Cliquez sur Exécuter le test.

Vous devriez recevoir une réponse (200 OK), avec des données retournées par l'API. Cela signifie que la requête API a contacté Toast avec succès et transfère des données.

Étape 4 : Créer un menu numérique dans Designer avec OptiSync

Maintenant que votre source de données de requête API est prête à l'emploi, vous pouvez créer votre DMB en utilisant Designer avec OptiSync. OptiSync vous permet de mapper les données API à un élément dans le designer, qu'il s'agisse de texte ou d'images. En utilisant les répéteurs, ces données peuvent être utilisées pour créer des menus à plusieurs éléments, et vous pouvez également définir comment vous souhaitez gérer les articles épuisés, les promotions, et plus encore.

Pour un guide étape par étape et plus d'exemples, veuillez consulter notre article sur la création de menus numériques en utilisant OptiSync.

C'est tout !

Vous avez récupéré avec succès les données de Toast et les avez affichées sur les écrans en utilisant OptiSigns.