Toast è uno dei sistemi Point-of-Sale più comuni in Nord America. In questo articolo, spiegheremo come configurare l'integrazione API tra il tuo sistema Toast e OptiSigns.
- Passaggio 1: Preparazione
- Passaggio 2: Autenticazione all'API Toast
- Passaggio 3: Chiamare l'API per ottenere i dati richiesti da Toast
- Passaggio 4: Creare il DMB Designer con OptiSync
Toast fornisce un'API per consentire agli utenti di integrare i dati POS con altri sistemi. Con OptiSync, creare menu digitali che si aggiornano automaticamente dai dati della tua API Toast è semplice.
L'API Toast richiede un token di autenticazione generato dinamicamente da fornire con ogni chiamata API, a differenza di molti altri sistemi POS che utilizzano una chiave API statica. Questo aggiunge una certa complessità all'integrazione che altri sistemi POS non hanno. Tuttavia, utilizzando la richiesta API di OptiSigns e OptiSync, queste complessità aggiuntive non sono affatto un problema.
In questo articolo, forniremo una guida passo-passo su come integrare la tua API Toast utilizzando la richiesta API di OptiSigns e come creare un DMB usando OptiSync. Di seguito sono riportati i passaggi principali che seguiremo:
1. Ottenere le informazioni richieste dal portale Toast
2. Ottenere il Token di Autenticazione da Toast (all'interno del passaggio Pre-Request)
3. Chiamare l'API per ottenere i dati richiesti da Toast
4. Utilizzare i dati dell'API Toast per creare DMB nel designer con OptiSync
Passaggio 1: Preparazione
Per iniziare con l'integrazione di un'API Toast con OptiSigns, abbiamo bisogno delle seguenti informazioni dal sistema Toast:
- toast-api-hostname
- clientId
- clientSecret
- userAccessType
Fare riferimento alla documentazione di Toast qui per ulteriori dettagli.
| NOTA |
| Per utilizzare l'API di Toast per leggere i dati, è richiesto l'accesso API Standard di Toast. Questo di solito comporta un costo aggiuntivo (a Toast) di $25/mese per sede. |
Passaggio 2: Autenticazione per l'API Toast
Per l'autenticazione dell'API Toast, dovremo prima inviare la richiesta POST per ottenere il token di autenticazione. Il token di autenticazione viene quindi utilizzato per passare nella richiesta API per ottenere i dati dai menu, ordini ecc. di Toast.
Questo processo di autenticazione verrà gestito utilizzando l'elaborazione Pre-request con la richiesta API di OptiSigns. Per maggiori informazioni sull'elaborazione Pre-request e sulle richieste API in generale, si prega di consultare qui.
Nella fase di elaborazione Pre-request, l'API OptiSigns chiama l'API di autenticazione per ottenere il token necessario e lo imposta nel contesto della richiesta API.
In questo esempio, il token è impostato sulla variabile di contesto "authorization". Quando viene effettuata la richiesta API, sarà in grado di utilizzare il token di autenticazione. Di seguito è riportata una schermata di questo esempio in pratica.
Utilizzare questo snippet di codice (con i dati ottenuti in precedenza che riempiono le "xxx") per
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));
Passaggio 3: Chiamare l'API per ottenere i dati richiesti da Toast
Ora utilizzeremo il token di autorizzazione ricevuto nell'elaborazione Pre-request e lo passeremo all'intestazione della chiamata API effettiva.
Nella scheda Header, creare due parametri con i seguenti valori:
authorization Bearer {{authorization}}
Toast-Restaurant-External-ID
È possibile ottenere il valore Toast-Restaurant-External-ID dal Portale Toast. Questo è l'ID specifico del ristorante di cui si desidera ottenere i dati.
Ora inserire l'URL API desiderato da cui si desidera ottenere i dati. In questo esempio abbiamo utilizzato la seguente API per ottenere i menu
La richiesta finale apparirà più o meno così:
È possibile abilitare questa richiesta e salvare l'API. Fare clic su Esegui Test.
Dovresti ricevere una risposta (200 OK), con i dati restituiti dall'API. Ciò significa che la richiesta API ha contattato con successo Toast e sta trasferendo i dati.
Passaggio 4: Creare Menu Digitale nel Designer con OptiSync
Ora che la tua origine dati di richiesta API è pronta per l'uso, puoi creare il tuo DMB utilizzando Designer con OptiSync. OptiSync ti consente di mappare i dati API a un elemento nel designer, sia testo che immagini. Utilizzando i Repeater, questi dati possono essere utilizzati per creare menu con più articoli e sei anche in grado di definire come desideri gestire gli articoli esauriti, le offerte speciali e altro ancora.
Per una guida passo-passo e altri esempi, consulta il nostro articolo su Creazione di Menu Digitali Utilizzando OptiSync.
È tutto!
Hai recuperato con successo i dati da Toast e li hai visualizzati sugli schermi utilizzando OptiSigns.