Doorlinken Voorraad Beheertool Koppeling Eigen Website

Uitloggen

Documentatie

U bent hier : Home / Documentatie

Algemene omschrijving

Er zijn twee manieren om de voorraad te ontvangen

Bulk (batchgewijs)

In deze methode van ontsluiting wordt op vaste (instelbare) tijdstippen de gehele voorraad geëxporteerd naar de FTP server van uw website-ontwikkelaar. Dit is, afhankelijk van de instellingen, een ZIP-bestand met daarin een XML-bestand met de voorraad en de bijbehorende foto’s. Om de bestanden niet onnodig groot te maken worden alleen nieuwe en gewijzigde foto’s uitgeleverd.
Incrementeel (real-time)

Bij deze methode van ontsluiting wordt iedere mutatie (toevoegen/wijzigen/verwijderen) van een voertuig naar een pagina op uw webserver ('endpoint') gestuurd. Met deze methode is het mogelijk om uw website zonder merkbare vertraging up-to-date te houden.

Referenties

Changelog

Bekijk de changelog

Karakterset

Alle communicatie vindt plaats in Unicode (UTF-8). Gebruikt uw database of website een andere karakterset, zoals Windows-1252 of ISO-8859-1, dan zult u de gegevens eerst moeten converteren alvorens ze op te slaan.

Leads

Indien de website erin voorziet dat bezoeker in contact met de verkoper kunnen komen, bijvoorbeeld via een contact- of proefritformulier, dan kan dit middels onderstaand endpoint aan het lead managent systeem van de verkoper worden doorgegeven. Het endpoint ondersteunt zowel REST (JSON), SOAP als form values (application/www-form-urlencoded of multipart/form-data).

REST (JSON)

De lead kan in de vorm van een JSON-object middels HTTP POST naar https://eigenwebsite.dv.nl/v1/leads/deliver.html worden gestuurd. Het systeem geeft een JSON response terug met ofwel {"success": true, "leadId": nnn} (waarbij nnn het ID is dat de lead toegewezen heeft gekregen) ofwel {"success": false, "error": "sss"}, waarbij sss een foutmelding is. In de tabel hieronder staan de mogelijke velden.

SOAP

De WSDL is te vinden op https://eigenwebsite.dv.nl/v1/leads/deliver.html?wsdl. Als de aanvraag niet verwerkt kan worden levert dit een SOAP Fault op.

Form values

De formulieren kunnen via HTTP POST naar https://eigenwebsite.dv.nl/v1/leads/deliver.html worden gestuurd. Dit levert of 'OK:nnn' op waarbij nnn het ID is dat de lead toegewezen heeft gekregen, of 'ERR:sss' waarbij sss een foutmelding is.

Velden

Veld (REST/SOAP)	Veld (form values)	Type	Verplicht	Details
`key`	`key`	string	ja	Deze sleutel: Log in om de sleutel te zien.
`klantnummer`	`klantnummer`	string	ja	Het klantnummer van de adverteerder die de lead moet ontvangen. Dit is hetzelfde klantnummer als gebruikt wordt in de voertuigdata.
`voertuignr`	`voertuignr`	string	nee	Het unieke nummer van de advertentie waar de lead betrekking of heeft. Dit is hetzelfde nummer als gebruikt wordt de voertuigdata (voertuignr_hexon).
`lead`	-	object	ja	De informatie van de lead zelf.
`lead`/`received`	`received`	datetime	nee	De datum en tijd waarop de lead is ontvangen (formaat: jjjj-mm-dd uu:mm:ss). Als dit niet aangeleverd wordt, wordt de huidige datum en tijd gebruikt.
`lead`/`type`	`leadType`	enum	ja	Het type van de lead: 'information_request' (de klant vraagt om meer informatie), 'test_drive' (de klant wil een afspraak maken voor een testrit), 'offer_request' (de klant wil een persoonlijke offerte), 'trade_in_request' (zelfde als offer_request, maar met een inruilvoertuig), 'lease_request' (de klant vraagt financiering of lease aan), 'contact_me' (de klant wil dat er contact wordt opgenomen), 'bid' (de klant heeft een bod gedaan op het voertuig), 'complaint' (de klant heeft een klacht) of 'other' (iets anders, onbekend of een combinatie hiervan).
`lead`/`contactDetails`	-	object	nee	De informatie van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`salutation`	`contactSalutation`	enum	nee	De aanhef van de persoon die de lead heeft aangemaakt: 'De heer' of 'Mevrouw'.
`lead`/`contactDetails`/`initials`	`contactInitials`	string	nee	De voorletters van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`first_name`	`contactFirstName`	string	nee	De voornaam van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`infix`	`contactInfix`	string	nee	De tussenvoegsels van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`last_name`	`contactLastName`	string	nee	De achternaam van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`name`	`contactName`	string	nee	De volledige naam van de persoon die de lead heeft aangemaakt. Dit veld kan gebruikt worden als de volledige naam wel bekend is, maar de voornaam, het tussenvoegsel en de achternaam afzonderlijk niet.
`lead`/`contactDetails`/`street`	`contactStreet`	string	nee	De straatnaam van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`house_number`	`contactHouseNumber`	integer	nee	Het huisnummer van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`house_number_ext`	`contactHouseNumberExt`	string	nee	De huisnummertoevoeging van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`address`	`contactAddress`	string	nee	Het adres van de persoon die de lead heeft aangemaakt. Dit veld kan gebruikt worden als het adres wel bekend is, maar de straatnaam, het huisnummer en de huisnummertoevoeging afzonderlijk niet.
`lead`/`contactDetails`/`postal_code`	`contactPostalCode`	string	nee	De postcode van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`city`	`contactCity`	string	nee	De woonplaats van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`province`	`contactProvince`	string	nee	De provincie van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`country`	`contactCountry`	string	nee	Het land van de persoon die de lead heeft aangemaakt.
`lead`/`contactDetails`/`email`	`contactEmail`	string	nee	Het e-mailadres waarmee contact kan worden opgenomen met de persoon die de lead heeft gemaakt.
`lead`/`contactDetails`/`telephone`	`contactTelephone`	string	nee	Het telefoonnummer waarmee contact kan worden opgenomen met de persoon die de lead heeft gemaakt.
`lead`/`title`	`title`	string	nee	Een korte omschrijving van de lead.
`lead`/`message`	`message`	string	ja	De daadwerkelijke inhoud van de lead.
`lead`/`website`	`website`	string	nee	De naam van de website vanaf waar de lead afkomstig is.
`lead`/`tradeInDetails`	-	object	nee	De informatie van het eventuele inruilvoertuig.
`lead`/`tradeInDetails`/`license_plate`	`tradeInLicensePlate`	string	nee	Het kenteken van het inruilvoertuig.
`lead`/`tradeInDetails`/`make_model_type`	`tradeInMakeModelType`	string	nee	Het merk, model en type van het inruilvoertuig.
`lead`/`tradeInDetails`/`make`	`tradeInMake`	string	nee	Het merk van het inruilvoertuig.
`lead`/`tradeInDetails`/`model`	`tradeInModel`	string	nee	Het model van het inruilvoertuig.
`lead`/`tradeInDetails`/`type`	`tradeInType`	string	nee	Het type en de versie van het inruilvoertuig.
`lead`/`tradeInDetails`/`odometer_value`	`tradeInOdometerValue`	integer	nee	De tellerstand van het inruilvoertuig.
`lead`/`tradeInDetails`/`odometer_unit`	`tradeInOdometerUnit`	enum	nee	De eenheid van de tellerstand: K (kilometer), M (mijlen)
`lead`/`tradeInDetails`/`transmission`	`tradeInTransmission`	enum	nee	De transmissie van het inruilvoertuig: manual, automatic, semi-manual or cvt
`lead`/`tradeInDetails`/`fuel`	`tradeInFuel`	enum	nee	De brandstof van het inruilvoertuig: Petrol, Diesel, LPG, LPG G3, Electric, CNG, Hydrogen, Bio-ethanol, Biodiesel, E85, HCNG, LPG + Petrol, LPG + Diesel, LPG G3 + Petrol, LPG G3 + Diesel, Electric + Diesel, Electric + Petrol, Hybrid, Other
`lead`/`tradeInDetails`/`price_new`	`tradeInPriceNew`	decimal	nee	De nieuwprijs van het inruilvoertuig.
`lead`/`tradeInDetails`/`date_1st_reg`	`tradeInDate1stReg`	date	nee	De datum van eerste registratie van het inruilvoertuig. (formaat: jjjj-mm-dd)
`lead`/`tradeInDetails`/`buildyear`	`tradeInBuildYear`	integer	nee	Het bouwjaar van het inruilvoertuig.
`lead`/`tradeInDetails`/`remarks`	`tradeInRemarks`	string	nee	De opmerkingen bij het inruilvoertuig.
`lead`/`more_information_link`	`leadMoreInformationLink`	string	nee	Link naar een pagina met meer informatie.
`lead`/`bid`	`leadBid`	decimal	nee	Het bod op een voertuig door de persoon die de lead heeft aangemaakt.
`testmode`	`testmode`	boolean	nee	Als dit de waarde 1 heeft, wordt de lead niet opgeslagen. Als de invoer correct is, wordt lead id 12345 opgeleverd. Met testmode kunt u gebruik maken van de waarde 'dummy' voor de velden `clientId` en `vehicleId`, in dat geval worden deze velden niet gecontroleerd.

Veel gestelde vragen

Welke koppelmethode (incrementeel of bulk) is beter?

Het antwoord op deze vraag is afhankelijk van uw wensen en technische mogelijkheden. Over het algemeen is de incrementele variant (XML POST) de meest voor de hand liggende keuze: de website is altijd actueel; is relatief eenvoudig te implementeren; u ontvangt de meest rijke dataset aan gegevens.

Documentatie

Onderwerpen

Algemene omschrijving

Bulk (batchgewijs)

Incrementeel (real-time)

Referenties

Changelog

Karakterset

Leads

REST (JSON)

SOAP

Form values

Velden

Veel gestelde vragen

Welke koppelmethode (incrementeel of bulk) is beter?

Ik wil slechts een deel van mijn voorraad adverteren. Hoe doe ik dit?

Hoe genereer ik thumbnails van de foto's?

Waarom staan er rare tekens in de teksten (bijv. CitroÃ«n)?

Het aantal voertuigen op mijn website komt niet overeen met het aantal voertuigen in mijn voorraadbeheerapplicatie. Wat nu?

Ik gebruikt een oudere versie, hoe zie ik de bijbehorende ondersteunde velden?