Backend purchase nieuw

Het Purchase event dient te worden verzonden, naar het API endpoint van Squeezely, als een aankoop wordt bevestigd in het ordersysteem. Daarnaast wordt aangeraden om de purchase ook vanuit de frontend te triggeren.

Waarom wordt zowel frontend als backend tracking aangeraden voor het purchase event?

Vanwege de volgende situaties wordt zowel de frontend als backend purchase aangeraden:

De frontend purchase wordt niet altijd getriggerd omdat de bedankpagina niet wordt ingeladen
Door sommige Adblockers worden de cookies niet geaccepteerd en worden dus geen frontend events naar Squeezely verstuurd

In onderstaande voorbeeld komt het voordeel van het versturen van beiden tot uiting:

Alleen frontend purchase	Frontend & Backend purchase
Profiel A doet een aankoop Profiel A klikt de bedankpagina weg voordat deze wordt ingeladen = geen frontend purchase, dus geen purchase	Profiel B doet een aankoop Profiel B klikt de bedankpagina weg voordat deze wordt ingeladen = geen frontend purchase Vanuit het ordersysteem wordt doorgegeven dat Profiel B een aankoop heeft gedaan = backend purchase

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)

Waar vind ik de authenticatie waardes van mijn account?

Ga naar Settings
Bekijk:
- Account ID, dit is de X-AUTH-ACCOUNT
- API key, dit is de X-AUTH-APIKEY

Let op: zorg ervoor dat je geen van deze API-endpoints implementeert in front-end code. Dit levert beveiligingsproblemen op, aangezien de authenticatie headers dan in elk verzoek worden opgenomen.

Formatie

Het event dat naar de API endpoints wordt verzonden, dient de indeling JavaScript Object Notation (JSON) te hebben of te zijn opgenomen als HTTP POST parameters. 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:

Veldlabel		Veldinhoud
event		Purchase
email		Emailadres van het profiel
orderid		Id van de order
products	id	Id van het aangeschafte product
products	quantity	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!

Een voorbeeld van de Backend Purchase API Call vind je hier: https://squeezely.tech/documentation#backend-purchase (zie Example)

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 velden toegevoegd aan het event, die benodigd zijn voor het opzetten van use cases.

Welke datavelden kan ik meesturen in het event?

Een overzicht van de datavelden die je mee kunt sturen in het event, vind je hier: 📄 Datavelden

Hoe kan ik custom datavelden meesturen in het event?

Allereerst dien je de custom datavelden aan te maken in Squeezely: 🛠 Aanmaken custom datavelden

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.

Controleren

Na de implementatie kun je de volgende twee dingen controleren:

De respons op de API call
Het event in Squeezely

De volgende respons op de API call is correct:

De volgende respons is incorrect:

Wat dien ik te doen bij een incorrecte respons?

Ga naar: https://rc.squeezely.tech/documentation#backend-api
Scrol naar beneden en controleer de respons code
Controleer de implementatie

Het event kun je in Squeezely als volgt controleren:

Ga naar: https://squeezely.tech/data/audience/new
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://squeezely.tech/documentation#backend-purchase