Mutiara van der Linden

De vernieuwde Copernica REST API is uitgerold!

Geschreven door Mutiara van der Linden ,  Selina Blijleven op
Vernieuwde API calls

Deze week is Versie 2 van de Copernica REST API uitgerold. De REST API wordt gebruikt om automatische koppelingen met Copernica te maken. De vernieuwde versie van de REST API bevat een aantal bugfixes en verbeteringen, waardoor de calls consistent, uitgebreider en duidelijker zijn. Hieronder bespreken we de belangrijkste veranderingen.

Nieuwe calls met betrekking tot mailings en statistieken

In versie 2 van de REST API zijn er veel nieuwe calls toegevoegd waarmee informatie over mailings en statistieken opgevraagd kan worden. Het is nu bijvoorbeeld mogelijk om voor de Marketing Suite de bestemmingen van een e-mail of de statistieken van een template op te vragen. Kijk voor een compleet overzicht van alle nieuwe calls op de verbeterde REST API documentatie pagina.

Verbeterde structuur

In Versie 2 van de REST API is er voor een aantal calls onderscheid gemaakt tussen calls met betrekking tot de Marketing Suite en de Publisher. Voor gebruikers zal de url van de call er dus anders uitzien. In calls met betrekking tot de Marketing Suite wordt nu verwezen naar “ms” zoals api.copernica.com/v2/ms/emailings bijvoorbeeld.

Een aantal calls die al mogelijk waren met de Publisher waren een lange tijd ongedocumenteerd. In het nieuwe overzicht kun je deze nu vinden. Als je voorheen al gebruik maakte van deze calls, kan het je opvallen dat het formaat van de input en output veranderd is en dat de output in sommige gevallen uitgebreid is.

Checklist

Klaar om zelf aan de slag te gaan met de nieuwe REST API? De volgende checklist zal je helpen om een soepele start te maken met versie 2.

  • Als je PHP gebruikt, download dan de nieuwe Copernica REST API klasse. Het voorbeeld dat je hier kan vinden laat zien hoe je een Versie 2 API object kan instantiëren. Tot versie 1 compleet vervangen wordt is het op deze manier mogelijk om voorlopig twee API versies te gebruiken.
  • Als je de POST-call of PUT-call gebruikt voor profielen in de database zal je merken dat de gegevens anders moeten worden doorgegeven omdat het bewerken of toevoegen van interesses aan een profiel nu ook ondersteund wordt.
  • Controleer of al je specifieke Marketing Suite/ Publisher calls verwijzen naar het juiste adres.
  • Controleer of de calls om logfiles op te halen naar behoren werken.
  • Raadpleeg voor meer informatie de REST API documentatie.