MailPlus API

Succesvolle e-mail marketing staat nooit volledig op zichzelf. Door een integratie van systemen haalt u het maximale uit MailPlus en uw e-mail marketingactiviteiten. Een koppeling maakt het mogelijk om de sterke punten van MailPlus en een CRM-systeem, webwinkel, ERP of ander systeem te combineren. Voor deze integratie biedt MailPlus een krachtige REST API. Op deze plek in het Kenniscentrum leest u alles over deze API en treft u tips over hoe u een integratie tot stand brengt.

Interactive API DocumentationTechnische documentatie

Naast een beschrijving in dit Kenniscentrum biedt MailPlus ook de “Interactive API Documentation“. Hierin treft u als ontwikkelaar een compleet overzicht van alle methodes van de MailPlus 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 Kenniscentrum 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 (MailPlus eCom)
 Synchroniseren van orders (MailPlus eCom)
 Aansturen van automatische campagnes
✓ Integreren van MailPlus-formulieren
 Doorgeven van directe conversie ten behoeve van rapportages (MailPlus eCom)
 Ophalen van rapportages en respons op e-mail marketingactiviteiten

Globale werking van de koppeling

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

Om een extern systeem met MailPlus te laten ‘praten’, heeft u een stukje software nodig aan de kant van het externe systeem. Dit noemen we een ‘connector’. Aan de kant van MailPlus is de API beschikbaar, waar de connector tegenaan kan praten. De connector en de MailPlus 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 MailPlus 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 MailPlus-account. Deze komen beschikbaar als u de REST API in dat account activeert en een nieuwe authenticatie aanmaakt. In MailPlus eCom is dit al voor u gedaan. Onderstaande video laat stap voor stap zien hoe u de REST API activeert:

Best Practices

Verschillende integraties zijn al gerealiseerd met de MailPlus 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 MailPlus. Dit kan verschillende oorzaken hebben. Door gebruik te maken van een wachtrij, maakt u 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 opnieuw te proberen met een oplopende interval. Bijvoorbeeld de eerste keer na 1 minuut, dan na 5 minuten, dan na 10 minuten, dan na een uur, et cetera. De wachtrij dient daarbij op chronologische volgorde te 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 dient het externe systeem een start- en eindtijd van de afgelopen periode mee te sturen sinds de vorige ophaalactie. Bijvoorbeeld bij het ophalen van gebounce’de of gewijzigde contacten. Om er zeker van te zijn dat er geen wijzigingen gemist worden, is het raadzaam om een marge van minstens 10 minuten aan te houden tussen het moment van ophalen en de eindtijd van de periode.

Technische documentatie

Technische documentatie

Speciaal voor ontwikkelaars: alle methodes van de MailPlus API op een rij en ready to test.
» Bekijk de technische documentatie

Hulp nodig?

Bij vragen over de MailPlus API helpen we u graag verder:
+31 (0)79 - 363 12 12 / support@nl.spotler.com