Introductie REST API

Succesvolle e-mail marketing staat nooit volledig op zichzelf. Door een integratie van systemen haal je het maximale uit Spotler en je e-mail marketingactiviteiten. Een koppeling maakt het mogelijk om de sterke punten van Spotler en een CRM-systeem, webwinkel, ERP of ander systeem te combineren. Voor deze integratie biedt Spotler een krachtige REST API. Op deze plek in het Spotler Help Center lees je alles over deze API en vind je tips over hoe je een integratie tot stand brengt.

Technische documentatie

Naast een beschrijving in het Spotler Help Center biedt Spotler ook de Interactive API Documentation. Hierin vind je als ontwikkelaar een compleet overzicht van alle methodes van de Spotler API met de bijbehorende technische documentatie. Elke methode is daarbij voorzien van een korte toelichting en een mogelijkheid om deze uit te proberen. In de verdere uitleg in het Spotler Help Center wordt regelmatig verwezen naar specifieke onderdelen van de technische documentatie.

Alle mogelijkheden op een rij

De mogelijkheden van een integratie zijn globaal in te delen in onderstaande toepassingen:

✓ Synchroniseren van contacten
✓ Synchroniseren van producten (Spotler eCommerce)
✓ Synchroniseren van orders (Spotler eCommerce)
✓ Aansturen van automatische campagnes
✓ Integreren van Spotler-formulieren
✓ Doorgeven van directe conversie ten behoeve van rapportages (Spotler eCommerce)
✓ Ophalen van rapportages en respons op e-mail marketingactiviteiten

Globale werking van de koppeling

Voor een integratie via de Spotler REST API spelen vier onderdelen een cruciale rol: een extern systeem, een ‘connector’, een Spotler-account en de Spotler API.

Om een extern systeem met Spotler te laten ‘praten’, heb je een stukje software nodig aan de kant van het externe systeem. Dit noemen we een ‘connector’. Aan de kant van Spotler is de API beschikbaar, waar de connector tegenaan kan praten. De connector en de Spotler API zorgen er samen voor dat er twee kanten op kan worden gecommuniceerd tussen beide systemen. Zo kunnen de eerder genoemde toepassingen worden uitgevoerd, zoals het synchroniseren van contacten of het ophalen van rapportage.

Authenticatie

Voor het inzetten van de Spotler API vindt bij iedere aanroep een authenticatie plaats. Op deze manier wordt geverifieerd of een aanroep vanuit de juiste bron (het gekoppelde systeem) wordt gedaan. Bij iedere API-aanroep dient er een zogenaamde Key en Secret meegegeven te worden, waarmee de API-service kan bepalen of de aanroep in orde is. Keys en Secrets zijn altijd gekoppeld aan één Spotler-account. Deze worden beschikbaar wanneer je de REST API in dat account activeert en een nieuwe authenticatie aanmaakt. In Spotler eCommerce is dit al voor je gedaan.

Lees meer over hoe je de REST API activeert in het artikel Hoe activeer ik de REST API?

Best Practices

Verschillende integraties zijn al gerealiseerd met de Spotler API. Hier zijn twee belangrijke best practices uit naar voren gekomen:

Maak gebruik van een wachtrij

Er kan altijd iets mis zijn met de verbinding tussen het externe systeem en Spotler. Dit kan verschillende oorzaken hebben. Door gebruik te maken van een wachtrij, maak je de koppeling robuust voor deze omstandigheden. Hoe werkt het wachtrijprincipe? Als een API aanroep faalt, omdat er iets mis is met de verbinding, dan wordt de aanroep automatisch opgeslagen in een wachtrij. Zo kan de connector nieuwe pogingen doen met dezelfde aanroep. Ons advies is om het een beperkt aantal keren met een oplopende interval opnieuw te proberen. Bijvoorbeeld de eerste keer na 1 minuut, dan na 5 minuten, dan na 10 minuten, dan na een uur, et cetera. De wachtrij moet daarbij op chronologische volgorde worden afgewerkt. Daarnaast is het handig om mislukte aanroepen in een overzicht te tonen in de backend van het externe systeem.

Hanteer een 10 minuten marge

Bij sommige methodes moet het externe systeem een start- en eindtijd van de afgelopen periode meesturen sinds de vorige ophaalactie. Bijvoorbeeld bij het ophalen van gebouncede of gewijzigde contacten. Om er zeker van te zijn dat er geen wijzigingen gemist worden, raden we aanom een marge van minstens 10 minuten aan te houden tussen het moment van ophalen en de eindtijd van de periode.

Wat zijn de voordelen van een koppeling? Het belangrijkste voordeel van een koppeling is tijdwinst! Dat geldt met name voor de marketeer, die zonder koppeling veel tijd kwijt is met het handmatig importeren en exporteren van gegevens tussen beide systemen. Met een geautomatiseerde koppeling via de Spotler REST API beschikt de marketeer altijd over de meest actuele contactgegevens in Spotler. Dit scheelt niet alleen tijd, maar het is ook minder foutgevoelig. Ook de weg terug kan geregeld worden. Zo kunnen wijzigingen, afmeldingen, bounces en respons op je e-mail marketingactiviteiten automatisch uit Spotler worden opgehaald. Het is niet alleen de makkelijkste manier om je bestand schoon te houden, maar levert het ook nog eens verkoopkansen op! Met een koppeling bundel je de krachten van beide systemen.