API Documentation

Advertentie maken

Het is mogelijk om via de API een advertentie te plaatsen op Agriplaats. De advertenties worden automatisch onder het account gezet waar de autorisatie code aan gekoppeld is. Advertenties worden automatisch gepubliceerd op Agriplaats.

Endpoint URL

https://api.agriplaats.nl/advertisements/create

De verplichte en optionele POST velden

`title`	Titel	maximaal 50 tekens	`required`
`description`	Omschrijving	HTML toegestaan tussen <![CDATA[]]>	`required`
`id_category`	Categorie	zie categorieën lijst voor juiste ID	`required`
`specs`	Specificaties	zie categorieën lijst voor de verplichte velden	`required`
`country`	Land	zie landenlijst voor juiste waarde	`required`
`place`	Plaatsnaam		`required`
`zipcode`	Postcode	verplicht wanneer het in Nederland is	`required`
`contact_name`	Contactpersoon	Naam van persoon of bedrijf	`required`
`emailaddress`	E-mailadres	contact e-mailadres (hoeft niet hetzelfde te zijn als het account)	`required`
`phone_number`	Telefoonnummer
`price_type`	Prijstype	zie prijs type lijst voor juiste prijs type	`required`
`price`	Prijs	zie prijs type lijst voor verplichting van prijs
`images`	Foto's	base64 images maximaal 10 foto's per advertentie

Voorbeeld PHP/CURL

$ch = curl_init($api_url . '/advertisements/create');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
    'api_key' => 'P4YD6F21K16U',
    'authorisation_key' => 'jcxZw5TU46NW1zrakTip7ZpWIgTj1fCmQAR1UZSmC18jUKIm',
    'title' => array(
        'nl' => 'Advertentie via de API'
    ),
    'description' => array(
        'nl' => 'CDATA[< p >Omschrijving van de Advertentie via de API< /p >]'
    ),
    'id_category' => 1,
    'specs' => array(
        'brand' => 'New Holland',
        'state' => 'lang_new',
        'drive' => 'lang_fourwheeldrive',
    ),
    'country' => 1,
    'zipcode' => '5301KB',
    'place' => 'Zaltbommel',
    'contact_name' => 'Agriplaats.nl',
    'emailaddress' => 'contact@example.com',
    'phone_number' => '+31 (0)85 40 18 971',
    'price_type' => 1,
    'price' => 1750.00,
    'images' => array(
        array(
            'base64' => '/9j/4AAQSkZJRgABAQAAAQABAAD//........NH//2Q==',
            'filename' => 'Images001.jpg',
        ),
        array(
            'base64' => '/9j/4AAQSkZJRgABAQAAAQABAAD//........NH//2Q==',
            'filename' => 'Images002.jpg',
        ),
    )
)));

$result = curl_exec($ch);

Voorbeeld JSON resultaat

{"id_advertisement":"25", "url" => "https://www.agriplaats.nl/redirect/ad/25"}

Advertentie bewerken

Het bewerken van een advertentie gaat op dezelfde manier als het maken van een advertentie, echter is nu de ID van de advertentie verplicht. Foto's worden opnieuw aan de advertentie gekoppeld als deze meegestuurd worden. Veranderd er niets aan de foto's dan is het niet noodzakelijk deze opnieuw mee te sturen.

Endpoint URL

https://api.agriplaats.nl/advertisements/edit

De verplichte en optionele POST velden

`id_advertisement`	ID	deze krijg je als resultaat bij het maken van de advertentie	`required`
`title`	Titel	maximaal 50 tekens	`required`
`description`	Omschrijving	HTML toegestaan tussen <![CDATA[]]>	`required`
`id_category`	Categorie	zie categorieën lijst voor juiste ID	`required`
`specs`	Specificaties	zie categorieën lijst voor de verplichte velden	`required`
`country`	Land	zie landenlijst voor juiste waarde	`required`
`place`	Plaatsnaam		`required`
`zipcode`	Postcode	verplicht wanneer het in Nederland is	`required`
`contact_name`	Contactpersoon	Naam van persoon of bedrijf	`required`
`emailaddress`	E-mailadres	contact e-mailadres (hoeft niet hetzelfde te zijn als het account)	`required`
`phone_number`	Telefoonnummer
`price_type`	Prijstype	zie prijs type lijst voor juiste prijs type	`required`
`price`	Prijs	zie prijs type lijst voor verplichting van prijs
`images`	Foto's	base64 images maximaal 10 foto's per advertentie

Voorbeeld PHP/CURL

$ch = curl_init($api_url . '/advertisements/edit');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
    'api_key' => 'P4YD6F21K16U',
    'authorisation_key' => 'jcxZw5TU46NW1zrakTip7ZpWIgTj1fCmQAR1UZSmC18jUKIm',
    'id_advertisement' => 25,
    'title' => array(
        'nl' => 'Advertentie via de API, bewerkt'
    ),
    'description' => array(
        'nl' => 'CDATA[< p >Omschrijving van de Advertentie via de API< /p >]'
    ),
    'id_category' => 1,
    'specs' => array(
        'brand' => 'New Holland',
        'state' => 'lang_new',
        'drive' => 'lang_fourwheeldrive',
    ),
    'country' => 1,
    'zipcode' => '5301KB',
    'place' => 'Zaltbommel',
    'contact_name' => 'Agriplaats.nl',
    'emailaddress' => 'contact@example.com',
    'phone_number' => '+31 (0)85 40 18 971',
    'price_type' => 3,
    'price' => 2050.75,
    'images' => array(
        array(
            'base64' => '/9j/4AAQSkZJRgABAQAAAQABAAD//........NH//2Q==',
            'filename' => 'Images001.jpg',
        ),
        array(
            'base64' => '/9j/4AAQSkZJRgABAQAAAQABAAD//........NH//2Q==',
            'filename' => 'Images002.jpg',
        ),
    )
)));

$result = curl_exec($ch);

Voorbeeld JSON resultaat

{"id_advertisement":"25", "url" => "https://www.agriplaats.nl/redirect/ad/25"}

Advertentie verwijderen

Het verwijderen via de API gebeurd via de ID van de advertentie. Deze ID ontvang je bij het maken van een advertentie.

Endpoint URL

https://api.agriplaats.nl/advertisements/delete

De verplichte en optionele POST velden

id_advertisement ID deze krijg je als resultaat bij het maken van de advertentie required

Voorbeeld PHP/CURL

$ch = curl_init($api_url . '/advertisements/delete');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
    'api_key' => 'P4YD6F21K16U',
    'authorisation_key' => 'jcxZw5TU46NW1zrakTip7ZpWIgTj1fCmQAR1UZSmC18jUKIm',
    'id_advertisement' => 25,
)));

$result = curl_exec($ch);

Voorbeeld JSON resultaat

{"success": true}

Statistieken

Voor het opvragen van de statistieken van een advertentie is enkel de ID van de advertentie noodzakelijk. Vervolgens kunnen deze gegevens opgeslagen worden in de eigen software. Deze gegevens zijn realtime.

Endpoint URL

https://api.agriplaats.nl/advertisements/statistics

De verplichte en optionele POST velden

id_advertisement ID deze krijg je als resultaat bij het maken van de advertentie required

Voorbeeld PHP/CURL

$ch = curl_init($api_url . '/advertisements/statistics');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
    'api_key' => 'P4YD6F21K16U',
    'authorisation_key' => 'jcxZw5TU46NW1zrakTip7ZpWIgTj1fCmQAR1UZSmC18jUKIm',
    'id_advertisement' => 25,
)));

$result = curl_exec($ch);

Voorbeeld JSON resultaat

{"views": 331, "bids": 3, "favorite": 5}

Advertentie maken
Advertentie bewerken
Advertentie verwijderen
Statistieken

API Documentation

Advertentie maken

Advertentie bewerken

Advertentie verwijderen

Statistieken

Menu