Het Purchase event dient te worden verzonden, naar het API endpoint van SqueezelySpotler Activate, 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.
Bij gebruik van Copernica kan de backend purchase ontvangen worden via de koppeling van:
🔗 Bookerz
| Expand | ||||
|---|---|---|---|---|
| ||||
Vanwege de volgende situaties wordt zowel de frontend als backend purchase aangeraden:
In onderstaande voorbeeld komt het voordeel van het versturen van beiden tot uiting:
|
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)
| Expand | ||
|---|---|---|
| ||
|
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
In het Backend Purchase event worden de volgende velden minimaal meegestuurd:
Veldlabel | Veldinhoud | |
|---|---|---|
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 SqueezelySpotler Activate!
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 database worden meegestuurd. Wellicht zijn er in het Data Plan /wiki/spaces/SG/pages/1272807432 velden toegevoegd aan het event, die benodigd zijn voor het opzetten van use cases.
...
| Expand | ||
|---|---|---|
| ||
Allereerst dien je de custom datavelden aan te maken in SqueezelySpotler Activate: 🛠 Custom datavelden makenaanmaken Vervolgens kun je deze meesturen met de veldlabel: custom_(naam van het veld). In het geval van het custom dataveld custom_provincie dient dus bijvoorbeeld custom_provincie meegestuurd te worden. |
Implementatie
De documentatie voor het implementeren van de Backend Purchase via API Calls, vind je hier: https://Spotler Activate.tech/documentation#backend-purchase
Controleren
Na de implementatie kun je de API call controleren met de response value. Meer informatie over de response values vind je hiervolgende twee dingen controleren:
De respons op de API call
Het event in Spotler Activate
De volgende respons op de API call is correct:
...
De volgende respons is incorrect:
...
| Expand | ||
|---|---|---|
| ||
|
Het event kun je in Spotler Activate als volgt controleren:
Ga naar: https://
...
...
Klik op custom
Stel de volgende regels in:
Events = purchase
Name = Test backend purchase
Retention = 1
Save de audience en wacht tot de status ‘Live’ is
Ga naar Audiences
Klik op ‘Inspect’
...
Klik op een event ID
...
Controleer de volgende velden in het event:
Created at: is dit een tijdstip na de implementatie van de API Call? Zo niet, selecteer een ander event ID.
Api inserted & api verified: bevat een van deze velden ‘yes’? Dan is het event correct geïmplementeerd. Zo niet, controleer de implementatie.
...
Let op: de frontend en backend purchase worden samengevoegd op basis van het order id. Wanneer je alleen een backend purchase stuurt, zijn de consent velden niet zichtbaar in het event. Een wijziging van de consent kun je controleren in het profiel van het event.
Meer informatie over de backend purchase vind je hier: https://squeezelySpotler Activate.tech/documentation#backend-purchase
...