Hoe configureer ik een integratie met Piggy?

Dit document beschrijft wat er op dit moment wordt ondersteund in de integratie met Piggy en hoe dit moet worden ingericht.

Piggy werkt met contacten en identifiers. Een identifier is in feite gewoon een spaarkaart waarmee de klant kan worden opgezocht.
Het gespaarde en verzilverde saldo zit binnen Piggy vast aan het contact, niet de identifier.
Een contact kan ook meerdere identifiers hebben.

Het verzilveren van saldo gebeurd via beloningen.
Er kunnen van te voren beloningen worden geconfigureerd binnen Piggy.
Wanneer een klant saldo wil verzilveren gebeurd dit door het innen van een volledige beloning. 

Inrichting binnen Piggy

API integratie

Om te zorgen dat RetailVista verbinding kan maken met Piggy dient een API integratie geactiveerd te worden.
Hiervoor wordt een kassa integratie aangemaakt.

Ga hiervoor via de bolletjes rechts boven naar 'Integraties, en dan naar 'Kassa's.

Kies voor "Koppel kassa" rechts boven en voeg een kassa toe, bijvoorbeeld:

Ga vervolgens naar de tab persoonlijke toegangstokens en maak daar een "personal access token" aan. LET OP: bewaar het token. Deze is later niet terug te zien, maar is later nog nodig voor configuratie in RetailVista

Beloningen

Op dit moment ondersteund RetailVista alleen het verzilveren van beloningen waardoor de klant een korting krijgt op de transactie (simpelweg het verzilveren van spaarsaldo). Gratis artikelen weggeven wordt nog niet ondersteund. 

Om dit te configureren dienen een aantal vaste attributen te worden aangemaakt binnen piggy. Ga hiervoor naar het radar icoontje rechts boven, en dan naar "Aangepaste kenmerken". Kies dan rechts boven voor 'Beloning' om aangepaste kenmerken voor beloningen aan te kunnen maken.

De volgende attributen moeten worden aangemaakt:

Uiteindelijk ziet dit er dan zo uit:

Aanmaken van een nieuwe beloning:
Om nu een nieuwe beloning aan te maken ga je naar "Sparen", en dan naar "Beloningen":

Geef als titel een duidelijke tekst, bijvoorbeeld "1 euro korting". één punt is normaal gesproken één cent waard, dus de benodigde punten zet je op 100 voor 1 euro korting:

Bij de tab "geavanceerd" zijn de attributen te zien die in de vorige stap zijn aangemaakt. Zet discountType op "Bedrag" en  apply_to op "Hele order". Bij discount_value wordt de korting in centen opgeven. Bij 1 euro korting moet hier dus 100 worden ingevoerd:

Inrichting binnen RetailVista

Spaarkaart connector
Binnen RetailVista moet een spaarkaart connector worden aangemaakt, op de volgende manier:

Reguliere expressie is herkenning van de spaarkaart (Identifier in Piggy). Het is belangrijk dat goed wordt afgestemd met Piggy welke identifiers gebruikt kunnen worden. Het is niet verstandig om numerieke identifiers te kiezen die kunnen overlappen met artikelnummers of artikel barcodes. Een veilige optie is een alfanumerieke code van 8 karakters, daar past de reguliere expressie uit het plaatje hier boven bij.
Provider Type is uiteraard Piggy, voer als Url de url in zoals hier boven en geef bij geavanceerde instellingen op "apitoken=[xxxxxx]", waarbij xxxxxx het token is wat hier boven in Piggy aangemaakt is.

Reguliere expressie: [a-zA-Z0-9]{8}
Provider Type: Piggy
Url: https://api.piggy.nl/api/v3/register

Spaarkaart type
Er moet ook een spaarkaart type worden aangemaakt. Deze wordt gebruikt om o.a. op de bon weer te geven hoeveel er is gespaard of opgenomen. Geef als waarde en opname waarde 0,01 op, om te zorgen dat één punt gelijk staat aan één cent:

Instellingen
Twee instellingen zijn van belang:

1. Sectie Point of Sale, tab Loyaliteit en geef daar bij Externe korting connector de zojuist aangemaakte connector op.
2. Sectie Loyaliteit, tab eLoyalty, geef daar als spaarkaart type het zojuist aangemaakt spaarkaart type op, zodat die gebruikt wordt voor de Piggy spaarkaarten.

POS

Sync de kassa en start deze opnieuw op. Daarna moet het mogelijk zijn om een identifier uit Piggy te scannen en moet deze worden herkent. 

Via Loyaliteit - Claim Loyalty vouchers zijn de beloningen terug te zien die in Piggy zijn geconfigureerd. Mits voldoende saldo kunnen hier beloningen worden geactiveerd om te verzilveren:

Indien gewenst is is ook mogelijk om dit scherm te openen via een knop in de touchscreen.

Verder is het mogelijk om dit scherm automatisch te openen na het scannen van de spaarkaart wanneer er een bepaald aantal punten is bereikt. Als dit gewenst is dan moet er bij het spaarkaart type in RetailVista bij "Minimum waarde voor opname" worden opgegeven bij hoeveel punten dit scherm geopend moet worden. Stel dat de laagste beloning 1 euro is, en minimum waarde voor opname staat op 1 euro, dan wordt dit scherm direct getoond wanneer de spaarkaart meer dan 100 punten heeft. Dit is ook een indicatie naar de caissière dat er voldoende saldo is om een beloning te innen.