Toast är ett av de vanligaste kassasystemen i Nordamerika. I den här artikeln förklarar vi hur du konfigurerar API-integration mellan ditt Toast-system och OptiSigns.
- Steg 1: Förberedelse
- Steg 2: Autentisering till Toast API
- Steg 3: Anropa API:et för att hämta nödvändig data från Toast
- Steg 4: Bygg DMB Designer med OptiSync
Toast tillhandahåller ett API för användare att integrera POS-data med andra system. Med OptiSync är det enkelt att bygga automatiskt uppdaterande digitala menytavlor från dina Toast API-data.
Toast API kräver en dynamiskt genererad autentiseringstoken som måste tillhandahållas vid varje API-anrop, till skillnad från många andra POS-system som använder en statisk API-nyckel. Detta lägger till viss komplexitet i integrationen som andra POS-system inte har. Men med hjälp av OptiSigns API-förfrågan och OptiSync är dessa tillagda komplexiteter inga problem alls.
I den här artikeln ger vi en steg-för-steg-guide om hur du integrerar ditt Toast API med OptiSigns API-förfrågan, och hur du skapar en DMB med OptiSync. Nedan är de övergripande stegen vi kommer att följa:
1. Hämta nödvändig information från Toast-portalen
2. Hämta autentiseringstoken från Toast (Inuti förförfrågningssteget)
3. Anropa API:et för att hämta nödvändig data från Toast
4. Använd Toast API-data för att bygga DMB i designer med OptiSync
Steg 1: Förberedelse
För att komma igång med att integrera ett Toast API med OptiSigns behöver vi följande information från Toast-systemet:
- toast-api-hostname
- clientId
- clientSecret
- userAccessType
Se Toasts dokumentation här för mer information.
| OBS |
| För att använda Toasts API för att läsa data krävs Toast Standard API-åtkomst. Detta medför vanligtvis en extra kostnad (till Toast) på $25/månad per plats. |
Steg 2: Autentisering för Toast API
För Toast API-autentisering måste vi först skicka POST-förfrågan för att få autentiseringstoken. Autentiseringstoken används sedan för att skicka med i API-förfrågan för att hämta data från Toast-menyer, beställningar etc.
Denna autentiseringsprocess hanteras med förförfrågningsbehandling med OptiSigns API-förfrågan. För mer information om förförfrågningsbehandling och API-förfrågningar i allmänhet, vänligen se här.
I förförfrågningsbehandlingsfasen anropar OptiSigns API autentiserings-API:et för att få den nödvändiga token och ställer in den i API-förfrågans kontext.
I detta exempel sätts token till kontextvariabeln "authorization". När API-förfrågan görs kommer den att kunna använda autentiseringstoken. Nedan är en skärmdump av detta exempel i praktiken.
Använd detta kodavsnitt (med data som erhållits tidigare och fyll i "xxx") för att
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));
Steg 3: Anropa API:et för att hämta nödvändig data från Toast
Nu använder vi autentiseringstoken som vi fick i förförfrågningsbehandlingen och skickar den till det faktiska API-anropets header.
I Header-fliken, skapa två parametrar med följande värden:
authorization Bearer {{authorization}}
Toast-Restaurant-External-ID
Du kan få Toast-Restaurant-External-ID-värdet från Toast-portalen. Detta är det specifika restaurang-ID som du vill hämta data för.
Ange nu önskad API-URL från vilken du vill hämta data. I detta exempel har vi använt följande API för att hämta menyerna
Den slutliga förfrågan kommer att se ut ungefär så här:
Du kan aktivera denna förfrågan och spara API:et. Klicka på Kör test.
Du bör få ett (200 OK) svar, med data som returneras från API:et. Detta betyder att API-förfrågan framgångsrikt har kontaktat Toast och överför data.
Steg 4: Bygg digital menytavla i Designer med OptiSync
Nu när din API-förfrågans datakälla är redo att användas kan du bygga din DMB med Designer med OptiSync. OptiSync låter dig mappa API-data till ett element i designern, antingen text eller bilder. Med hjälp av Repeaters kan denna data användas för att bygga menyer med flera artiklar, och du kan också definiera hur du vill hantera slutsålda artiklar, specialerbjudanden och mer.
För en steg-för-steg-guide och fler exempel, vänligen se vår artikel om Bygga digitala menytavlor med OptiSync.
Det är allt!
Du har framgångsrikt hämtat data från Toast och visat den på skärmarna med OptiSigns.