REST-API voor salesfunnel

Laatste update: 11-07-2023 22:41

Basis

Een van de manieren om leads in leads(totaal) te krijgen is middels de REST-API. Deze leads komen dan automatisch in leads(Totaal) te staan. Als u toegang wil krijgen tot de API kan dit door middel van een API key. Deze kan opgevraagd worden via support@syntec-it.nl.

Documentatie 

Let op: Vervang dev met de dealer waarvoor de leads bedoeld zijn (dus bijvoorbeeld pondealer.leadnet.nl)
URL : https://dev.leadnet.nl/json/leadnetapi/lead
API key : (deze kunt u opvragen via support@syntec-it.nl)

De url zal er dan als volgt uit zien: https://dev.leadnet.nl/json/leadnetapi/lead?api_key=(api key)
Er is een mogelijkheid om in te loggen met de API-key op een web-portal met documentatie welke response gegeven kunnen worden, dit kan op https://dev.leadnet.nl.

De verzoeken gaan eerst naar onze dev-omgeving, zodra deze (in overleg) akkoord zijn kunnen we de toegang tot uw eigen Syntec openzetten.

Het JSON bericht dient minimaal te voldoen aan de onderstaande structuur. 
Bij lege waarden "" doorsturen.

{
  "gender":"M",
  "initials":"T.S.T.",
  "firstname":"Test",
  "middlename":"de",
  "lastname":"Tester",
  "phone":"0337115711",
  "email":"t.tester@syntec-it.nl",
  "subject":"Onderwerp van lead",
  "street":"Florijnstraat",
  "houseno":"20",
  "zipcode":"4879AH",
  "city":"etten-leur"
}

In de volgende tabel staan alle mogelijke velden

key Vertaling Type Mogelijke waarden Basis structuur
subject Onderwerp tekst Onderwerp voor de lead Ja
gender Geslacht tekst M, V, O, Man, Vrouw, Male, Female Ja
initials Initialen tekst J.A Ja
firstname Voornaam tekst Jan Ja
middlename Tussenvoegsel tekst van der Ja
lastname Achternaam tekst Vliet Ja
phone Telefoon tekst 06-12345678 Ja
email E-mail tekst jan.van.der.vliet@example.com Ja
street Straat tekst Florijnstraat Ja
houseno Huisnummer tekst 20 Ja
zipcode Postcode tekst 4879AH Ja
city Plaats tekst Etten-leur Ja
gegevens_toestemming Gegevens toestemming teskt Ja, Nee Nee
remarks Opmerkingen tekst Vul hier vrije tekst in Nee
licenseplate Kenteken tekst 48TTGD Nee
komnummer Komnummer tekst 123456 Nee
brand Merk tekst Volkswagen, Audi, SEAT, SKODA, Volkswagen Bedrijfswagens Nee
model Model tekst up!, Polo, Golf, Passat Nee
car_description Voertuig omschrijving tekst Volkswagen Golf GTI 2.0 200PK DSG 6 Nee
channel Kanaal tekst WEBSITE (Zie afbeelding 1) Nee
establishment Vestiging tekst 200900 (Zie afbeelding 2) Nee
order_sort Ordersoort tekst NEW, OCC Nee
variant Lead variant tekst SALES, AFTERSALES Nee
prefered_establishment Voorkeurs vestiging tekst 200900 Nee
referentie_url Referentie URL tekst https://nu.nl Nee
attachments Bijlagen array Array met URL's naar de documenten. (PDF, PNG, JPG, GIF) Nee
tradeinlicenseplate Kenteken inruiler tekst 48TTGD Nee
tradeinbrand Merk inruiler tekst Volkswage,n, Audi, etc.. Nee
tradeinmodel Model inruiler tekst up!, Polo, etc Nee
tradeinmileage Km-stand inruiler getal 150000 Nee

Afbeelding 1.

Afbeelding 2.

Dynamische velden

Het is mogelijk om extra velden mee te geven aan de REST API die niet in de mapping staan.
Deze velden zullen dynamisch worden toegevoegd aan het overzicht.

In het voobeeld hieronder zijn er 2 velden toegevoegd genaamd "Vrij veld" en "Referentie code".
Deze veldnamen dien je zelf te verzinnen.

{
  "gender":"M",
  "initials":"T.S.T.",
  "firstname":"Test",
  "middlename":"de",
  "lastname":"Tester",
  "phone":"0337115711",
  "email":"t.tester@syntec-it.nl",
  "subject":"Onderwerp van lead",
  "street":"Florijnstraat",
  "houseno":"20",
  "zipcode":"4879AH",
  "city":"etten-leur",
  "vrij_veld":"Hier kan van alles staan",
  "referentie_code":"Bijvoorbeeld extern ID"
}

Deze velden zijn vervolgens terug te vinden in het bericht onder de kop "Overige"

Groepen

Het systeem kent een aantal vaste groepen

Groep Sleutel
Algemeen general
Partner partner
Adres address
Voertuig vehicle
Inruiler tradein
Overige misc
Systeem system

Wanneer er dynamische velden gebruikt worden kunnen deze toegevoegd worden aan 1 van de bestaande groepen.
In het voorbeeld voegen we 2 velden toe aan de groep "Algemeen" en 1 veld aan de groep "Partner"

{
  "gender":"M",
  "initials":"T.S.T.",
  "firstname":"Test",
  "middlename":"de",
  "lastname":"Tester",
  "phone":"0337115711",
  "email":"t.tester@syntec-it.nl",
  "subject":"Onderwerp van lead",
  "street":"Florijnstraat",
  "houseno":"20",
  "zipcode":"4879AH",
  "city":"etten-leur",
  "general": {
      "proefrit_datum":"24-06-2023",
      "referentie_code":"6YTDH"
    },
   "partner": {
      "mobiele_nummer":"06-12345678"      
    }
}

Deze velden zijn vervolgens terug te vinden bij de reeds bestaande groepen

Dynamische groepen

Het is mogelijk om zelf een dynamische groep met dynamische velden aan te maken.

{
  "gender":"M",
  "initials":"T.S.T.",
  "firstname":"Test",
  "middlename":"de",
  "lastname":"Tester",
  "phone":"0337115711",
  "email":"t.tester@syntec-it.nl",
  "subject":"Onderwerp van lead",
  "street":"Florijnstraat",
  "houseno":"20",
  "zipcode":"4879AH",
  "city":"etten-leur",
  "Financiering": {
      "Aankoopbedrag":"24.000",
      "Looptijd":"36 mnd",
      "Financierings datum":"24-06-2023",
      "Maandbedrag":"249",
      "Referentie code":"6YTDH"
    }
}

U heeft nog een vraag?

Onze helpdesk helpt u graag!

support@syntec-it.nl
Ma t/m Vr van 09:00 - 17:00