Toast ist eines der gängigsten Point-of-Sale-Systeme in Nordamerika. In diesem Artikel erklären wir, wie Sie die API-Integration zwischen Ihrem Toast-System und OptiSigns einrichten.
- Schritt 1: Vorbereitung
- Schritt 2: Authentifizierung bei der Toast-API
- Schritt 3: API-Aufruf zum Abrufen der erforderlichen Daten von Toast
- Schritt 4: Erstellen des DMB-Designers mit OptiSync
Toast bietet eine API, mit der Benutzer POS-Daten in andere Systeme integrieren können. Mit OptiSync ist das Erstellen automatisch aktualisierender digitaler Menütafeln aus Ihren Toast-API-Daten ganz einfach.
Die Toast-API erfordert ein dynamisch generiertes Authentifizierungs-Token, das bei jedem API-Aufruf mitgeliefert werden muss, im Gegensatz zu vielen anderen POS-Systemen, die einen statischen API-Schlüssel verwenden. Dies erhöht die Komplexität der Integration im Vergleich zu anderen POS-Systemen. Mit der API-Anfrage von OptiSigns und OptiSync sind diese zusätzlichen Komplexitäten jedoch überhaupt kein Problem.
In diesem Artikel bieten wir eine Schritt-für-Schritt-Anleitung zur Integration Ihrer Toast-API mit der OptiSigns-API-Anfrage und zum Erstellen eines DMB mit OptiSync. Im Folgenden sind die Hauptschritte aufgeführt, denen wir folgen werden:
1. Erforderliche Informationen aus dem Toast-Portal abrufen
2. Authentifizierungs-Token von Toast abrufen (innerhalb des Pre-Request-Schritts)
3. API aufrufen, um die erforderlichen Daten von Toast abzurufen
4. Toast-API-Daten verwenden, um DMB im Designer mit OptiSync zu erstellen
Schritt 1: Vorbereitung
Um mit der Integration einer Toast-API in OptiSigns zu beginnen, benötigen wir die folgenden Informationen aus dem Toast-System:
- toast-api-hostname
- clientId
- clientSecret
- userAccessType
Weitere Informationen finden Sie in der Toast-Dokumentation hier.
| HINWEIS |
| Um die Toast-API zum Lesen von Daten zu verwenden, ist ein Toast Standard API-Zugang erforderlich. Dies ist normalerweise mit zusätzlichen Kosten (an Toast) von 25 USD/Monat pro Standort verbunden. |
Schritt 2: Authentifizierung für die Toast-API
Für die Toast-API-Authentifizierung müssen wir zunächst eine POST-Anfrage senden, um das Authentifizierungs-Token zu erhalten. Das Authentifizierungs-Token wird dann in der API-Anfrage verwendet, um Daten von Toast-Menüs, Bestellungen usw. abzurufen.
Dieser Authentifizierungsprozess wird mit der Pre-Request-Verarbeitung der OptiSigns-API-Anfrage durchgeführt. Weitere Informationen zur Pre-Request-Verarbeitung und zu API-Anfragen im Allgemeinen finden Sie hier.
In der Pre-Request-Verarbeitungsphase ruft die OptiSigns-API die Authentifizierungs-API auf, um das erforderliche Token zu erhalten, und setzt es in den Kontext der API-Anfrage.
In diesem Beispiel wird das Token auf die Kontextvariable "authorization" gesetzt. Wenn die API-Anfrage gestellt wird, kann sie das Authentifizierungs-Token verwenden. Unten sehen Sie einen Screenshot dieses Beispiels in der Praxis.
Verwenden Sie diesen Code-Snippet (mit den zuvor erhaltenen Daten, die die "xxx" ersetzen), um
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));
Schritt 3: API aufrufen, um die erforderlichen Daten von Toast abzurufen
Jetzt verwenden wir das Authentifizierungs-Token, das wir in der Pre-Request-Verarbeitung erhalten haben, und übergeben es an den Header des tatsächlichen API-Aufrufs.
Erstellen Sie auf der Registerkarte Header zwei Parameter mit den folgenden Werten:
authorization Bearer {{authorization}}
Toast-Restaurant-External-ID
Sie können den Toast-Restaurant-External-ID-Wert aus dem Toast-Portal abrufen. Dies ist die spezifische Restaurant-ID, für die Sie Daten abrufen möchten.
Geben Sie nun die gewünschte API-URL ein, von der Sie Daten abrufen möchten. In diesem Beispiel haben wir die folgende API verwendet, um die Menüs abzurufen
Die endgültige Anfrage wird etwa so aussehen:
Sie können diese Anfrage aktivieren und die API speichern. Klicken Sie auf Test ausführen.
Sie sollten eine (200 OK)-Antwort erhalten, mit Daten, die von der API zurückgegeben werden. Dies bedeutet, dass die API-Anfrage erfolgreich Kontakt zu Toast aufgenommen hat und Daten überträgt.
Schritt 4: Digitale Menütafel im Designer mit OptiSync erstellen
Nachdem Ihre API-Anfrage-Datenquelle einsatzbereit ist, können Sie Ihre DMB mit dem Designer und OptiSync erstellen. OptiSync ermöglicht es Ihnen, die API-Daten einem Element im Designer zuzuordnen, entweder Text oder Bilder. Mit Repeatern können diese Daten verwendet werden, um Menüs mit mehreren Artikeln zu erstellen, und Sie können auch definieren, wie Sie mit ausverkauften Artikeln, Sonderangeboten und mehr umgehen möchten.
Eine Schritt-für-Schritt-Anleitung und weitere Beispiele finden Sie in unserem Artikel über das Erstellen digitaler Menütafeln mit OptiSync.
Das ist alles!
Sie haben erfolgreich Daten von Toast abgerufen und mit OptiSigns auf den Bildschirmen angezeigt.