Introductie
Met de REST API van Agriplaats is het mogelijk om vanuit eigen software gegevens te verwerken. In deze documentatie staan alle mogelijkheden beschreven en wordt uitgelegd hoe je gebruik kunt maken van de API.
Wanneer iets niet duidelijk is, of je hebt feedback, neem dan gerust contact met ons op via info[@]agriplaats.nl.
Direct aan de slag!
Requests
De verschillende functionaliteiten van de API zijn via onderstaande url aan te roepen. In de documentatie staat ook bij elke functie de enpoint (de url) genoemd.
De url is opgebouwd in een [module]
(bijvoorbeeld advertisements) en daarna de [action]
(bijvoorbeeld create). Om een advertentie te maken wordt de url dan:
https://api.agriplaats.nl/advertisements/create
Requests worden uitgevoerd doormiddel van de POST functionaliteit, vereiste velden dienen bij het verzoek mee gepost te worden.
Voorbeeld PHP / CURL
$ch = curl_init('https://api.agriplaats.nl/advertisements/create');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, array(
'api_key' => 'P4YD6F21K16U',
'authorisation_key' => 'jcxZw5TU46NW1zrakTip7ZpWIgTj1fCmQAR1UZSmC18jUKIm',
'title' => 'Advertentie titel'
));
$result = curl_exec($ch);
Wij adviseren om gebruik te maken van CURL waarbij de benodigde velden verstuurd kunnen worden.
Resultaten worden in JSON teruggestuurd door de API. Deze gegevens kun je zelf weer decoden en gebruiken in de eigen software.
Responses
Na het uitvoeren van een request sturen wij in de header het antwoord terug zodat de software dit verder af kan handelen.
200 | OK | Request was successful |
201 | Created | Entity creation was successful |
400 | Bad request | Parameters for the request are missing or malformed. Body contains the errors. |
401 | Authorization required | No authorization provided or invalid authorization information provided |