Toast is een van de meest gebruikte Point-of-Sale systemen in Noord-Amerika. In dit artikel leggen we uit hoe u API-integratie tussen uw Toast-systeem en OptiSigns instelt.
- Stap 1: Voorbereiding
- Stap 2: Authenticatie naar Toast API
- Stap 3: De API aanroepen om de benodigde gegevens van Toast op te halen
- Stap 4: De DMB Designer bouwen met OptiSync
Toast biedt een API waarmee gebruikers POS-gegevens kunnen integreren met andere systemen. Met OptiSync is het eenvoudig om automatisch bijwerkende digitale menuborden te bouwen vanuit uw Toast API-gegevens.
Toast API vereist een dynamisch gegenereerd authenticatietoken dat bij elke API-aanroep moet worden meegeleverd, in tegenstelling tot veel andere POS-systemen die een statische API-sleutel gebruiken. Dit voegt enige complexiteit toe aan de integratie die andere POS-systemen niet hebben. Met behulp van OptiSigns' API-verzoek en OptiSync zijn deze toegevoegde complexiteiten echter helemaal geen probleem.
In dit artikel bieden we een stapsgewijze handleiding over hoe u uw Toast API integreert met behulp van OptiSigns API-verzoek, en hoe u een DMB maakt met OptiSync. Hieronder staan de hoofdstappen die we zullen volgen:
1. Benodigde informatie ophalen uit Toast-portaal
2. Het authenticatietoken ophalen van Toast (binnen Pre-Request stap)
3. De API aanroepen om de benodigde gegevens van Toast op te halen
4. Toast API-gegevens gebruiken om DMB te bouwen in designer met OptiSync
Stap 1: Voorbereiding
Om te beginnen met het integreren van een Toast API met OptiSigns, hebben we de volgende informatie uit het Toast-systeem nodig:
- toast-api-hostname
- clientId
- clientSecret
- userAccessType
Raadpleeg de documentatie van Toast hier voor meer details.
| OPMERKING |
| Om de API van Toast te gebruiken voor het lezen van gegevens, is Toast Standard API-toegang vereist. Dit brengt meestal extra kosten met zich mee (aan Toast) van $25/maand per locatie. |
Stap 2: Authenticatie voor Toast API
Voor Toast API-authenticatie moeten we eerst het POST-verzoek doorgeven om het authenticatietoken te verkrijgen. Het authenticatietoken wordt vervolgens gebruikt om door te geven in het API-verzoek om de gegevens van Toast-menu's, bestellingen etc. op te halen.
Dit authenticatieproces wordt afgehandeld met behulp van Pre-request verwerking met OptiSigns' API-verzoek. Voor meer informatie over Pre-request verwerking en API-verzoeken in het algemeen, kijk hier.
In de Pre-request verwerkingsfase roept de OptiSigns API de authenticatie-API aan om het benodigde token te verkrijgen, en stelt dit in op de context van het API-verzoek.
In dit voorbeeld wordt het token ingesteld op de contextvariabele "authorization". Wanneer het API-verzoek wordt gedaan, kan het het authenticatietoken gebruiken. Hieronder staat een screenshot van dit voorbeeld in de praktijk.
Gebruik dit codefragment (met de eerder verkregen gegevens waarbij u de "xxx" invult) om
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));
Stap 3: De API aanroepen om de benodigde gegevens van Toast op te halen
Nu gebruiken we het autorisatietoken dat we hebben ontvangen in Pre-request verwerking en geven dit door aan de daadwerkelijke API-aanroep header.
Maak in het tabblad Header twee parameters aan met de volgende waarden:
authorization Bearer {{authorization}}
Toast-Restaurant-External-ID
U kunt de Toast-Restaurant-External-ID waarde verkrijgen uit Toast Portal. Dit is de specifieke restaurant-ID waarvoor u gegevens wilt ophalen.
Voer nu de gewenste API-URL in waarvan u gegevens wilt ophalen. In dit voorbeeld hebben we de volgende API gebruikt om de menu's op te halen
Het uiteindelijke verzoek ziet er ongeveer zo uit:
U kunt dit verzoek inschakelen en de API opslaan. Klik op Test uitvoeren.
U zou een (200 OK) reactie moeten ontvangen, met gegevens die terugkomen van de API. Dit betekent dat het API-verzoek succesvol contact heeft gemaakt met Toast en gegevens overdraagt.
Stap 4: Digitaal menubord bouwen in Designer met OptiSync
Nu uw API-verzoek gegevensbron klaar is voor gebruik, kunt u uw DMB bouwen met behulp van Designer met OptiSync. OptiSync stelt u in staat om de API-gegevens te koppelen aan een element in de designer, hetzij tekst of afbeeldingen. Met behulp van Repeaters kunnen deze gegevens worden gebruikt om menu's met meerdere items op te bouwen, en u kunt ook definiëren hoe u uitverkochte items, specials en meer wilt afhandelen.
Voor een stapsgewijze handleiding en meer voorbeelden, zie ons artikel over Digitale menuborden bouwen met OptiSync.
Dat is alles!
U heeft succesvol gegevens opgehaald van Toast en deze weergegeven op de schermen met behulp van OptiSigns.