Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

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.

 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

  1. Profiel A doet een aankoop

  2. Profiel A klikt de bedankpagina weg voordat deze wordt ingeladen = geen frontend purchase, dus geen purchase

  1. Profiel B doet een aankoop

  2. Profiel B klikt de bedankpagina weg voordat deze wordt ingeladen = geen frontend purchase

  3. 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. 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

email

Emailadres van het profiel

orderid

Id van de order

products

id

Id van het aangeschafte product

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!

De API Call ziet er bijvoorbeeld als volgt uit:

In de volgende omstandigheden zijn meer velden verplicht:

  1. Worden er meerdere talen gebruikt? → stuur dan ook language mee in de product array

  2. 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: 🛠 Custom datavelden maken

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 dien je de respons op de API call en het event in Squeezely te controleren.

De volgende respons op de API call is correct:

De volgende respons is incorrect:

 Wat dien ik te doen bij een incorrecte respons?

Het event kun je in Squeezely als volgt controleren:

  • Klik op een event ID (tip: controleer of het event is ontvangen na de implementatie. Zo niet, selecteer een andere event ID)

  • Controleer het event:

    • Heeft het veld ‘created at’ een tijdstip na dat het event is geïmplementeerd? Zo niet, selecteer een ander event ID.

    • Controleer de velden ‘api_inserted’ en ‘api_verified’

      • Bevat een van deze velden ‘yes’? Dan is het event correct geïmplementeerd. Zo niet, controleer de implementatie.

Meer informatie over de backend purchase vind je hier: https://squeezely.tech/documentation#backend-purchase

  • No labels