Het Purchase event dient te worden verzonden, naar het API endpoint van Squeezely, als een aankoop wordt bevestigd in het ordersysteem. Het verzenden van het event bestaat uit authenticatie en formatie.
Daarnaast wordt aangeraden om de purchase ook vanuit de frontend te triggeren.
Authenticatie
Het Squeezely API-endpoint vereist verificatie door middel van authenticatie. Authenticatie wordt uitgevoerd door in de headers van het HTTP request de volgende waardes te controleren:
X-AUTH-ACCOUNT: de identifier van het account (de gebruikersnaam van de API)
X-AUTH-APIKEY: de geheime API key (het wachtwoord van de API)
Formatie
De informatie die naar de API endpoints wordt verzonden, dient de indeling JavaScript Object Notation (JSON) te hebben of te zijn opgenomen als HTTP POST parameters. De reacties vanuit Squeezely zijn altijd in JSON indeling. Squeezely ondersteunt momenteel geen andere formaten zoals XML of andere methodes. Het API endpoints kan bereikt worden op: https://squeezely.tech
In het API Call wordt minimaal het volgende verstuurd:
Label | Inhoud | |
---|---|---|
event | Purchase | |
Emailadres van het profiel | ||
Id van de order | ||
Id van het aangeschafte product | ||
Aantal van het aangeschafte product |
Let op: het product id in het event dient overeen te komen met de SKU van het product in Squeezely!
De API Call ziet er bijvoorbeeld als volgt uit:
In de volgende omstandigheden zijn meer velden verplicht:
Worden er meerdere talen gebruikt? → stuur dan ook language mee in de product array
Worden er meerdere valuta gebruikt? → stuur dan ook currency mee in het event
Extra
In dit event kunnen extra datavelden uit de datalayer worden meegestuurd. Wellicht zijn er in het Data Plan velden toegevoegd aan het event, die benodigd zijn voor het opzetten van use cases. Als deze velden niet beschikbaar zijn bij de trigger, dienen deze te worden toegevoegd aan de datalayer. Tip: stuur alle velden mee die beschikbaar zijn bij de trigger in de datalayer en overleg met de gebruikers van Squeezely welke extra velden ze willen ontvangen in het event.
Controleren
Na de implementatie kun je de API call controleren met de response value. Meer informatie over de response values vind je hier: https://squeezely.tech/documentation#backend-tracking
Meer informatie over de backend purchase vind je hier: https://squeezely.tech/documentation#backend-purchase