Import-calls en gewijzigde responsen in de nieuwe v3-API
door Daniel Taylor , Jeroen Bizot
Vandaag introduceert Copernica de nieuwe v3-API. Daarmee kun je API-calls sneller uitvoeren.
De v3-API is te gebruiken via https://api.copernica.com/v3 en https://rest.copernica.com/v3.
Waarvoor gebruik ik de API?
De API biedt directe toegang tot Copernica-functionaliteiten zonder gebruik te hoeven maken van de interface. Je voert acties uit door HTTP-verzoeken te versturen. Het type verzoek (GET, POST, PUT of DELETE) is afhankelijk van de actie die je uitvoert. Denk bijvoorbeeld aan het updaten van een profiel, het aanmaken van een collectie of het verwijderen van een veld.
Zodra je verzoek verwerkt is retourneert de API een respons (statuscode). Aan de hand daarvan weet je of de actie succesvol is uitgevoerd.
Gewijzigde responsen
De responsen die je van de v3-API ontvangt zijn anders dan je gewend bent. PUT- en DELETE-verzoeken genereren nu standaard een '204 No Content'-respons. In eerdere versies ontving je hierop een '200 OK'-respons. Gebruik je een PUT-verzoek om meerdere entiteiten aan te maken? Dan retourneert de v3-API een '201 Created'- in plaats van een '303 See Other'-respons.
Toegevoegde import-calls
In de v3-API kun je nu ook een import starten door middel van een PUT-verzoek. Je specificeert het verzoek verder door variabelen (parameters) toe te voegen. De lijst van beschikbare parameters vind je hier.
Gebruik van eerdere versies
Door de uitrol van de v3-API zijn eerdere versies (v1 en v2) verouderd. We raden het gebruik van oudere versies daarom af.
Meer weten?
Wil je meer informatie over de v3-API? Lees dan de bijbehorende documentatie.