LeaseModulePortaal – REST API
Portaal – REST API

Portaal – REST API

Gebruik jouw portaalintegratie en de dealer-ID per klant.

Voorbeeld aanpassen en lokaal testen

Alleen de integratie-ID vervangen is niet voldoende. Pas deze drie waarden aan voordat je een voorbeeld gebruikt:

ParameterJouw waarde
integration_idUitsluitend de integratie-ID uit de aansluitmail. Kopieer geen tekst zoals “API-key eindigt op …” mee.
originHet exacte adres van de website waarin het iframe staat: protocol, domein en eventuele poort, zonder pad. Voorbeeld.nl is een invulvoorbeeld en is niet automatisch toegestaan. Externe websites moeten geregistreerd en actief zijn.
dealer_idDe actieve dealer-ID van de betreffende klant binnen jouw portaal. LO-00002 is slechts een voorbeeld; gebruik jouw eigen overzicht.

Lokaal testen

Voor iframes zijn localhost en 127.0.0.1 via HTTP en HTTPS met elke poort automatisch toegestaan bij actieve integraties. Aanmelden als klantdomein is hiervoor niet nodig. Gebruik een lokale webserver, geen file://. De integratie, het onderdeel en de dealer-ID moeten wel actief zijn.

Dit voorbeeld gaat uit van http://localhost:3000. Pas de poort aan jouw omgeving aan en vervang beide ID’s. De geregistreerde dealerwebsite blijft de echte klantwebsite.

<iframe src="https://leasemodule.nl/api/embed/?integration_id=JOUW_INTEGRATIE_ID&origin=http%3A%2F%2Flocalhost%3A3000&type=standalone&dealer_id=JOUW_DEALER_ID" title="Leasecalculator" width="100%" height="650" style="border:0;width:100%"></iframe>

Voor een live website gebruik je bij origin het geregistreerde websiteadres, bijvoorbeeld https%3A%2F%2Fwww.klant.nl. De URL moet correct worden gecodeerd, bijvoorbeeld met encodeURIComponent(window.location.origin). Een geheime API-key hoort nooit in het iframe.

Foutmeldingen

  • Dit domein is niet toegestaan: controleer origin; laat voorbeeld.nl niet staan. Controleer protocol, www en poort.
  • Ongeldige integratie-ID: kopieer uitsluitend de ID.
  • Dealer-ID niet actief: controleer de dealer-ID en de actieve klant binnen dit portaal.
  • 422 bij vehicle/monthly: aanschafprijs moet groter dan nul zijn; merk en model zijn verplicht. Geef een prijs als 24950 of 24950.50 mee, zonder valutateken of duizendtalscheiding. Bij andere API-verzoeken lees je de JSON-foutdetails.
  • 403 Forbidden of Unexpected token <: controleer de HTTP-response. Een HTML-foutpagina is geen JSON. Neem contact op met de beheerder; voor iframe- en API-mappen moet index.php bereikbaar zijn.

De lokale uitzondering geldt voor iframes. Rechtstreekse REST API-verzoeken vanuit een backend blijven een API-key vereisen. Een testaanvraag wordt normaal verwerkt en kan e-mails versturen.

Onderdelen in deze handleiding

Leasecalculator bij een voertuig · Maandprijs · Losse calculator · Leasevoorraad (optioneel) · Leaseprofiel.

JavaScript-widgets en WordPress staan hieronder als alternatief naast de rechtstreekse REST API-koppeling. Een widget bouwt de interface voor je; bij de REST API bouw je die zelf.

1. JavaScript-widget — de eenvoudigste eigen plaatsing

Plaats de LeaseModule-calculator op een website door een HTML-element en het bestaande JavaScript-bestand toe te voegen. Gebruik dit als je geen rechtstreekse REST API-koppeling wilt bouwen.

i
VoorafBij portalen voeg je bij ieder klantonderdeel de juiste data-dealer-id uit het dealer-ID-overzicht toe. Een portaal kan per klant dezelfde integratie-ID gebruiken, maar de juiste dealer-ID is verplicht om aanvragen correct toe te wijzen. De provider moet het websitedomein hebben toegestaan.
  1. Neem de integratie-ID over uit de e-mail van de leaseprovider.
  2. Plaats het geschikte HTML-element in de detailpagina, voertuigkaart of financieringspagina.
  3. Laad het script leasemodule.js één keer per pagina en controleer de calculator op mobiel.

Voertuigcalculator op een detailpagina

Gebruik data-type="vehicle" en vul de voertuiggegevens vanuit het bestaande voorraadsysteem in.

Voorbeeldcode — kopiëren en aanpassen
<div class="leasemodule-calculator"
  data-type="vehicle"
  data-integration-id="JOUW_INTEGRATIE_ID"
  data-dealer-id="LO-00002"
  data-reference="VWE12345"
  data-aanschafprijs="24950"
  data-voertuigsoort="Personenauto"
  data-merk="Volkswagen"
  data-model="Golf"
  data-brandstof="Benzine"
  data-bouwjaar="2022"
  data-kenteken="G123AB"
  data-btwmarge="btw"
  data-dealernaam="Voorbeeld Autobedrijf"
  data-dealerwebsite="https://voorbeeld.nl"
  data-voertuigurl="https://voorbeeld.nl/aanbod/golf">
</div>

<script src="https://leasemodule.nl/api/widget/v1/leasemodule.js" async></script>

Maandprijs op voertuigkaarten

Gebruik leasemodule-monthly-price voor een indicatief maandbedrag in een voertuigoverzicht. Herhaal het HTML-element per voertuig, maar laad het script slechts één keer.

Voorbeeldcode — kopiëren en aanpassen
<div class="leasemodule-monthly-price"
  data-integration-id="JOUW_INTEGRATIE_ID"
  data-dealer-id="LO-00002"
  data-reference="VWE12345"
  data-aanschafprijs="24950"
  data-voertuigsoort="Personenauto"
  data-merk="Volkswagen"
  data-model="Golf"
  data-brandstof="Benzine"
  data-bouwjaar="2022"
  data-kenteken="G123AB"
  data-btwmarge="btw"
  data-dealernaam="Voorbeeld Autobedrijf"
  data-dealerwebsite="https://voorbeeld.nl"
  data-voertuigurl="https://voorbeeld.nl/aanbod/golf">
</div>

<script src="https://leasemodule.nl/api/widget/v1/leasemodule.js" async></script>

Losse calculator zonder voertuig

Gebruik data-type="standalone". De bezoeker vult zelf de aankoopprijs en andere gegevens in.

Voorbeeldcode — kopiëren en aanpassen
<div class="leasemodule-calculator"
  data-type="standalone"
  data-integration-id="JOUW_INTEGRATIE_ID"
  data-dealer-id="LO-00002">
</div>

<script src="https://leasemodule.nl/api/widget/v1/leasemodule.js" async></script>

Belangrijke data-attributen

AttribuutFunctie
data-integration-idJouw integratie-ID van de provider.
data-dealer-idAlleen bij portalen: dealer-ID van de betreffende klant.
data-typevehicle of standalone voor volledige calculators.
data-aanschafprijsVerkoopprijs als getal, bijvoorbeeld 24950.
data-voertuigsoortBijvoorbeeld Personenauto of Bedrijfswagen.
data-merk / data-modelMerk en model van de auto.
data-brandstof / data-bouwjaarBrandstof en viercijferig bouwjaar.
data-btwmargebtw of marge.
data-reference / data-kentekenVoertuigreferentie en kenteken.
data-dealernaam / data-dealerwebsiteDealernaam en dealer-URL.
data-voertuigurlURL van de voertuigdetailpagina.
!
Let opGebruik geen geheime API-sleutel in HTML of JavaScript. De widget regelt de benodigde clientintegratie op basis van de integratie-ID en domeintoestemming. De getoonde illustraties bevatten voorbeeldbedragen.

2. WordPress-plugin en shortcodes

Voor WordPress en Elementor is een bestaande LeaseModule-plugin beschikbaar. Plaats deze via Plugins → Nieuwe plugin → Plugin uploaden en configureer de integratiegegevens in WordPress.

Download LeaseModule WordPress-plugin ↓

Voertuigcalculator

Voorbeeldcode — kopiëren en aanpassen
[leasemodule_calculator aanschafprijs="24950" voertuigsoort="Personenauto" merk="Volkswagen" model="Golf" brandstof="Benzine" bouwjaar="2022" btwmarge="btw"]

Maandprijs voertuig

Voorbeeldcode — kopiëren en aanpassen
[leasemodule_monthly_price aanschafprijs="24950" voertuigsoort="Personenauto" merk="Volkswagen" model="Golf" brandstof="Benzine" bouwjaar="2022" btwmarge="btw"]

Losse calculator

Voorbeeldcode — kopiëren en aanpassen
[leasemodule_calculator type="standalone"]

De shortcodes kunnen in een WordPress Shortcode-blok of een Elementor Shortcode-widget worden geplaatst. De WordPress-plugin gebruikt de integratiegegevens uit de plugininstellingen. Controleer voor portaalgebruik apart of de geïnstalleerde plugin dealer-ID’s ondersteunt; gebruik anders de JavaScript-widget met data-dealer-id of de REST API.

3. REST API — voor maatwerkkoppelingen

Met de REST API bouwt een developer de calculator en aanvraagverwerking volledig zelf. Dit is vooral nuttig bij eigen voorraadplatformen, backoffice-integraties en maatwerk. Hieronder staan alle API-routes, variabelen, verzoeken, antwoorden en foutmeldingen.

Verschil met het script: de JavaScript-widget bouwt de interface zelf op; bij de REST API verwerk je JSON-gegevens en maak je de volledige gebruikersinterface zelf. De geheime API-sleutel blijft altijd server-side.

Iframe of REST API?

Gebruik de iframe-handleiding wanneer je een kant-en-klare calculator op een geregistreerd klantdomein wilt plaatsen. Hiervoor mag je nooit een geheime API-sleutel in de browsercode opnemen. Bouw je een eigen calculator of vraag je gegevens rechtstreeks vanuit je backend op? Gebruik dan de REST API met authenticatie via de requestheaders X-LeaseModule-Integration en X-LeaseModule-API-Key.

Testen: voor iframes zijn localhost en 127.0.0.1 automatisch toegestaan via HTTP en HTTPS, met elke poort. Geef het exacte lokale adres mee bij origin. Externe testdomeinen moeten wel geregistreerd zijn. Deze uitzondering vervangt geen REST API-authenticatie. Bij ontbrekende leaseprijzen controleer je eerst de responsecode en API-authenticatie.

4. Gegevens voor een rechtstreekse REST API-koppeling

Gebruik jouw portaalintegratie en de dealer-ID per klant.

Integratie-ID

Ontvang je per e-mail van de leaseprovider. Dit is een identificatie en geen geheime API-sleutel.

API-sleutel

Vraag de geheime API-sleutel afzonderlijk aan bij jouw leaseprovider. Bewaar deze uitsluitend server-side.

i
BelangrijkKoppel elke aanvraag aan de juiste klant/dealer-ID. Controleer de dealer-ID’s in de persoonlijke overzichtlink uit de e-mail.

REST API integreren in drie stappen

  1. Laat jouw websitebouwer de API-koppeling op een beveiligde server inrichten.
  2. Vraag de actuele API-sleutel en integratie-instellingen aan bij de leaseprovider.
  3. Verwerk voertuiggegevens, berekeningen en aanvragen via de API en test de complete aanvraagflow.

Gebruik de echte API-schema’s van jouw leaseprovider. Een browser mag nooit rechtstreeks over een geheime API-sleutel beschikken.

API-routes

De onderstaande paden bestaan in het LeaseModule-platform. De exacte requestvelden en authenticatievereisten zijn afhankelijk van het gekozen endpoint en de actieve providerinstellingen.

RouteFunctie
/api/v1/calculations/Een voertuigberekening
/api/v1/monthly-prices/Maandprijsberekening
/api/v1/monthly-prices/batch/Meerdere maandprijzen
/api/v1/applications/Financieringsaanvraag verwerken
/api/v1/inventory/Leasevoorraad (optioneel): lijst, details en filteropties
/api/v1/leaseprofiel/Gepubliceerd profiel van de gekoppelde leaseprovider (GET)
/api/v1/health/Beschikbaarheid controleren

Authenticatie en verzoeken

Gebruik POST met Content-Type: application/json voor berekeningen, aanvragen en voorraad. Leaseprofiel gebruikt GET. De integratie-ID identificeert de koppeling; de geheime API-sleutel hoort uitsluitend op de server.

Voorbeeldcode
POST /api/v1/calculations/ HTTP/1.1
Host: leasemodule.nl
Content-Type: application/json
X-LeaseModule-Integration: JOUW_INTEGRATIE_ID
X-LeaseModule-API-Key: JOUW_GEHEIME_API_SLEUTEL

{...JSON body...}

De server accepteert ook Authorization: Bearer JOUW_GEHEIME_API_SLEUTEL. Geef de sleutel nooit mee in publiek zichtbare JavaScript- of iframe-code.

Voor portalen: gebruik de dealer-ID van de betreffende klant. In het aanvraagverzoek komt deze onder vehicle.dealer_id. De API controleert of die dealer-ID bij de gebruikte integratie hoort. Bij berekeningen wordt deze dealer-ID in de huidige route niet apart verwerkt; rekenregels komen van de integratie.

Voertuigvelden en variabelen

Bij berekeningen staat het voertuig in vehicle; bij aanvraagverwerking eveneens. De validator verwacht de volgende velden:

Veld (JSON)VerplichtToelichting
aanschafprijsJaPositief bedrag, bijvoorbeeld 24950; verkoopprijs wordt ook geaccepteerd.
voertuigsoortJaPersonenauto, Bedrijfswagen, Bromfiets, Motorfiets, Vrachtwagen, Camper, Caravan of Brommobiel. Alternatief: soort.
merkJaMerk van het voertuig.
modelJaModel van het voertuig.
brandstofJaBenzine, Diesel, Elektrisch, Hybride, LPG, LPG-G3, CNG, Waterstof, Overig (en ondersteunde varianten).
bouwjaarJaViercijferig bouwjaar.
btwmargeJabtw of marge.
referenceNeeEigen voorraad-/advertentiereferentie.
kentekenNeeVoertuigkenteken.
dealernaamNeeNaam van de dealer.
dealerwebsiteNeeVolledige URL van de dealerwebsite.
voertuigurlNeeVolledige URL van de voertuigdetailpagina.

dealer_id is voor portaal-aanvragen bedoeld in vehicle.dealer_id en wordt bij aanvraagverwerking gevalideerd.

Berekeningsopties

VeldWaarBetekenis
productHoofdobjectbusiness, consumer of bij berekeningen both.
termoptions, business of consumerLooptijd in maanden. Beschikbare looptijden volgen de providerinstellingen.
down_paymentOptiesAanbetaling in euro.
final_paymentOptiesSlottermijn in euro; grenzen volgen de providerinstellingen.

De volledige calculator gebruikt aparte opties onder business en consumer. De maandprijsroutes gebruiken één object options.

Voertuigcalculator

Endpoint: POST /api/v1/calculations/. In dit voorbeeld berekent de server een zakelijke financiering.

Voorbeeldcode
{
  "vehicle": {
    "aanschafprijs": 24950,
    "voertuigsoort": "Personenauto",
    "merk": "Volkswagen",
    "model": "Golf",
    "brandstof": "Benzine",
    "bouwjaar": 2022,
    "btwmarge": "btw",
    "reference": "VWE12345",
    "kenteken": "G123AB"
  },
  "product": "business",
  "business": {
    "term": 60,
    "down_payment": 5000,
    "final_payment": 3000
  }
}

Het antwoord bevat onder andere success, request_id, calculation_id, currency, vehicle, valid_until en de berekening in business en/of consumer met een monthly_amount. Het daadwerkelijke bedrag wordt door LeaseModule berekend en is afhankelijk van de ingestelde providerregels.

Maandprijzen

Eén voertuig

Endpoint: POST /api/v1/monthly-prices/

Voorbeeldcode
{
  "vehicle": {
    "aanschafprijs": 24950,
    "voertuigsoort": "Personenauto",
    "merk": "Volkswagen",
    "model": "Golf",
    "brandstof": "Benzine",
    "bouwjaar": 2022,
    "btwmarge": "btw",
    "reference": "VWE12345",
    "kenteken": "G123AB"
  },
  "product": "business",
  "options": {
    "term": 60,
    "down_payment": 5000,
    "final_payment": 3000
  }
}

Het antwoord bevat reference, product, monthly_amount, monthly_amount_rounded, term, currency, price_rule en valid_until.

Meerdere voertuigen tegelijk

Endpoint: POST /api/v1/monthly-prices/batch/. Maximaal 50 voertuigen per verzoek.

Voorbeeldcode
{
  "vehicles": [
    {
      "aanschafprijs": 24950,
      "voertuigsoort": "Personenauto",
      "merk": "Volkswagen",
      "model": "Golf",
      "brandstof": "Benzine",
      "bouwjaar": 2022,
      "btwmarge": "btw",
      "reference": "VWE12345",
      "kenteken": "G123AB"
    },
    {
      "aanschafprijs": 17950,
      "voertuigsoort": "Personenauto",
      "merk": "Volkswagen",
      "model": "Polo",
      "brandstof": "Benzine",
      "bouwjaar": 2022,
      "btwmarge": "btw",
      "reference": "VWE12346",
      "kenteken": "G123AB"
    }
  ],
  "product": "business",
  "options": {
    "term": 60
  }
}

Het antwoord bevat een prices-lijst met per referentie het berekende maandbedrag, de afgeronde prijs en looptijd.

Financieringsaanvraag indienen

Endpoint: POST /api/v1/applications/. Onderstaand voorbeeld betreft een zakelijke aanvraag. Persoonsgegevens moeten via een beveiligde serververbinding worden verzonden.

Voorbeeldcode
{
  "vehicle": {
    "aanschafprijs": 24950,
    "voertuigsoort": "Personenauto",
    "merk": "Volkswagen",
    "model": "Golf",
    "brandstof": "Benzine",
    "bouwjaar": 2022,
    "btwmarge": "btw",
    "reference": "VWE12345",
    "kenteken": "G123AB",
    "dealer_id": "LO-00002"
  },
  "product": "business",
  "calculator_type": "vehicle",
  "form_started_at": "UNIX_TIJDSTEMPEL_VAN_FORMULIERSTART",
  "applicant": {
    "initials": "J.",
    "last_name": "Jansen",
    "email": "voorbeeld@example.nl",
    "phone": "0612345678"
  },
  "company": {
    "name": "Voorbeeld B.V.",
    "kvk": "12345678"
  },
  "options": {
    "term": 60
  },
  "website": ""
}

Let op: form_started_at moet een echte Unix-tijdstempel in seconden bevatten van het moment waarop het formulier is gestart. De applicatie vereist een minimale verstreken tijd van drie seconden en maximaal 24 uur. Het lege veld website is een anti-spamveld.

Voor zakelijke aanvragen zijn onder andere applicant.initials, applicant.last_name, applicant.email, company.name en company.kvk verplicht. Particuliere aanvragen vereisen extra persoonsgegevens, woonsituatie en inkomensgegevens, afhankelijk van de antwoorden. Gebruik daarvoor de actuele particuliere aanvraagvelden.

Bij succes retourneert de API HTTP 201 met onder andere success, request_id, application_id, xml_created en afleverstatussen.

Antwoorden en foutmeldingen

Een geslaagd verzoek bevat success: true. Bij een fout gebruikt LeaseModule de volgende structuur:

Voorbeeldcode
{
  "success": false,
  "request_id": "voorbeeld_request_id",
  "error": {
    "code": "validation_error",
    "message": "Een of meer velden zijn ongeldig."
  },
  "errors": [
    {
      "field": "aanschafprijs",
      "code": "required",
      "message": "Dit veld is verplicht."
    }
  ]
}

Veelvoorkomende statuscodes: 400 ongeldige JSON, 401 ontbrekende of foutieve authenticatie, 403 niet toegestane integratie, domein of dealer-ID, 422 ongeldige invoer of product.

Compleet server-side verzoek

Dit PHP-voorbeeld laat zien hoe de server een voertuigberekening verstuurt. Vervang de voorbeeldwaarden en sla de API-sleutel veilig buiten de openbare websitebestanden op. De JSON-velden zijn dezelfde als in de tabel hierboven. Voor portalen moet de juiste dealer-ID volgens het endpoint bij het verzoek worden betrokken; controleer dat vóór verwerking.

PHP-voorbeeld (server-side)
<?php
$payload = [
  'vehicle' => [
    'aanschafprijs' => 24950,
    'voertuigsoort' => 'Personenauto',
    'merk' => 'Volkswagen',
    'model' => 'Golf',
    'brandstof' => 'Benzine',
    'bouwjaar' => 2022,
    'btwmarge' => 'btw'
  ],
  'product' => 'business',
  'business' => [
    'term' => 60,
    'down_payment' => 5000,
    'final_payment' => 3000
  ]
];
$ch = curl_init('https://leasemodule.nl/api/v1/calculations/');
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 20,
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'X-LeaseModule-Integration: JOUW_INTEGRATIE_ID',
    'X-LeaseModule-API-Key: JOUW_GEHEIME_API_SLEUTEL'
  ],
  CURLOPT_POSTFIELDS => json_encode($payload)
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);
if ($response === false) {
  // Handel transportfouten af, toon geen API-sleutel in logs.
  throw new RuntimeException('Verbinding met LeaseModule mislukt');
}
$data = json_decode($response, true);
if ($status < 200 || $status >= 300 || !is_array($data)) {
  throw new RuntimeException('LeaseModule gaf geen succesvol antwoord');
}
// Verwerk hier het berekende maandbedrag volgens de responsevelden.

Antwoorden verwerken

Controleer altijd de HTTP-status, de success-waarde en het juiste productobject. Een berekening kan afhankelijk van de ingestelde leaseproducten onder business of consumer worden teruggegeven. Lees het werkelijke maandbedrag uit monthly_amount in het betreffende object; neem nooit een voorbeeldbedrag over.

Bij een aanvraag moet de website het ontvangen resultaat en eventuele validatiefouten opvangen. Gebruik request_id om technische problemen te kunnen herleiden zonder klantgegevens of geheime sleutels in logs te bewaren.

i
Let opVoor de REST API maak je geen iframe aan. De API geeft gegevens terug; het ontwerp van de calculator, voorraadkaart en aanvraagpagina verzorg je zelf op de website.

Beveiliging

  • Gebruik HTTPS en bewaar de API-sleutel alleen op de server.
  • Controleer klant- en voertuiggegevens voordat je een aanvraag doorstuurt.
  • Verstuur persoonsgegevens uitsluitend via beveiligde POST-verzoeken.
  • Registreer fouten en request-ID’s zonder geheime sleutels te loggen.

Losse calculator via REST API

Bij een losse calculator vult de bezoeker zelf de voertuiggegevens en het bedrag in. Bouw deze invoervelden in jouw eigen frontend en verstuur de ingevulde voertuiggegevens naar POST /api/v1/calculations/. Gebruik dezelfde verplichte velden en berekeningsopties als bij de voertuigcalculator.

Bij het indienen van de aanvraag naar /api/v1/applications/ gebruik je calculator_type: "standalone". Dit is een aanduiding van het aanvraagtype; de berekeningsroute blijft dezelfde. Geef bij iedere aanvraag de juiste vehicle.dealer_id mee.

Voor een kant-en-klare losse calculator kun je ook de JavaScript-widget hierboven gebruiken met data-type="standalone".

Leasevoorraad (optioneel)

Toon het eigen aanbod van iedere aangesloten klant, inclusief voertuigdetails en de beschikbare financieringsvormen.

Beschikbaar binnen Business en Enterprise wanneer Digifresh Leasevoorraad voor de leaseprovider heeft geactiveerd. Laat Digifresh de voorraadkoppeling inrichten. Een voorraadkoppeling gebruikt bestaande voorraad; deze importeert zelf geen voertuigen.

Jouw klantgegevens staan in de PDF-bijlage

Bij jouw aansluitmail ontvang je LeaseModule-installatieoverzicht.pdf. Hierin staan per klant de website, dealer-ID, plaatsings-ID en status. Gebruik de plaatsings-ID bij de juiste klantwebsite voor JOUW_PLAATSINGS_ID.

Staat er Nog niet ingericht? Vraag jouw leaseproviderbeheerder of Digifresh om de voorraadkoppeling. Na inrichting ontvang je een nieuwe aansluitmail met bijgewerkte PDF. Voor een direct aangesloten autobedrijf is geen dealer-ID nodig.

Eén voorraadkoppeling per klantwebsite

De portaalintegratie kan voor meerdere klanten worden gebruikt. Iedere klantwebsite krijgt een aparte voorraadkoppeling met een eigen openbare plaatsings-ID, klantnaam, exact HTTPS-domein en voorraadnummer(s). De plaatsings-ID bepaalt welke voorraad zichtbaar is; alleen de portaalintegratie-ID meesturen is niet voldoende.

GegevenFunctie
Portaalintegratie-IDKoppelt aan het portaal en de leaseprovider.
Dealer-IDIdentificeert een portaalklant bij calculatoraanvragen.
Voorraadnummer(s)Selecteren voertuigen uit de voorraadbron; niet automatisch hetzelfde als het dashboardklantnummer of de dealer-ID.
Plaatsings-IDUnieke code voor de voorraadweergave van één klantwebsite.

Voorbeeld: klant A en klant B delen de portaalintegratie, maar hebben ieder hun eigen domein, voorraadnummer(s) en plaatsings-ID. Kopieer voor iedere klant de eigen installatiecode uit Leaseaanbod. Deel geen algemene voorraadcode tussen klanten.

Beschikbaarheid via REST API

Gebruik POST /api/v1/inventory/ voor voertuigen, voertuigdetails en filteropties. Authenticeer uitsluitend op jouw server met X-LeaseModule-Integration en X-LeaseModule-API-Key. Geef de placement_id van de betreffende klantkoppeling mee; de API controleert of die plaatsing bij jouw integratie hoort. Neem deze ID over uit de installatiecode in Leaseaanbod.

Voorraad opvragen — server-side
POST https://leasemodule.nl/api/v1/inventory/
Content-Type: application/json
X-LeaseModule-Integration: JOUW_INTEGRATIE_ID
X-LeaseModule-API-Key: JOUW_GEHEIME_API_SLEUTEL

{
  "placement_id": "JOUW_PLAATSINGS_ID",
  "p": 1,
  "merk": "Volkswagen"
}

Voor een voertuigdetail stuur je dezelfde placement_id met car (de voertuigreferentie) mee. Voor filteropties zonder selectie stuur je alleen de placement_id. Filters: merk, model, brandstof, carrosserie, transmissie, soort, btw_marge (B of M), year_from en year_to. Er worden 15 voertuigen per pagina opgehaald via p; de huidige sortering is nieuwste plaatsing eerst.

Het antwoord bevat placement, items, pagination en filters. Per voertuig ontvang je reference, sold, photos, details, accessoires en de beschikbare productobjecten onder vehicles.business en/of vehicles.consumer. Gebruik het juiste productobject als vehicle voor de calculator- en maandprijsroutes. Deze objecten bevatten al de prijs volgens de btw-regels van dat product; voer niet opnieuw een btw-correctie uit.

Bereken het maandbedrag via /api/v1/monthly-prices/ of /api/v1/calculations/ met dezelfde looptijd, aanbetaling en slottermijn. De voorraadroute geeft zelf geen maandbedrag terug. Bouw de kaarten, detailpagina's en aanvraagformulieren in jouw eigen website. Stuur bij een portaal de teruggegeven dealer_id in vehicle.dealer_id bij de aanvraag mee.

Een onbekende, uitgeschakelde of vreemde plaatsing geeft HTTP 404. Een voertuig buiten deze voorraad geeft 404; een niet geactiveerde voorraadfunctie of afwijkende dealer-ID geeft 403. Bij een onbereikbare voorraadbron volgt 503. Toon bij sold: true geen calculator of aanvraagknop.

Alternatief: bestaande iframe-plaatsing

Installatiecode — vervang de voorbeeld-ID door de code van de betreffende klant
<div data-leasemodule-aanbod="JOUW_PLAATSINGS_ID"></div>
<script async src="https://leasemodule.nl/api/leaseaanbod/embed.js"></script>

Gebruik de volledige code uit Leaseaanbod → de betreffende koppeling. Het iframe mag uitsluitend op het ingestelde domein worden geplaatst. Met en zonder www zijn verschillende domeinen. Laat voor een extra domein een aparte koppeling inrichten.

Controleren vóór ingebruikname

  • Controleer dat alleen voertuigen van de juiste klant zichtbaar zijn, ook na filteren en bij het openen van een detailpagina.
  • Test foto's, filters, paginering en weergave op mobiel.
  • Vergelijk maandprijzen bij dezelfde looptijd, aanbetaling, slottermijn en btw-instelling.
  • Stem een herkenbare testaanvraag af en controleer klantnaam, website, voertuig en ontvangst bij de leaseprovider.
i
Aanvraagherkomst controlerenDe voorraadkoppeling zoekt de dealer-ID op binnen precies deze portaalintegratie en het geregistreerde klantdomein. De iframe-calculator stuurt die dealer-ID automatisch mee. Registreer de klant daarom eerst bij het portaal met een geldige dealer-ID en toegestaan domein. Bij een ontbrekende of verwijderde klantregistratie wordt de voorraadweergave geblokkeerd. Controleer een testaanvraag op de juiste dealer-ID vóór livegang.

Voertuigen die de voorraadbron als verkocht markeert krijgen geen calculator. Verwijderde voertuigen zijn niet meer te openen. Een verkoopsbanner in een foto wordt niet automatisch herkend. Een uitgeschakelde voorraadkoppeling toont geen aanbod meer.

Leaseprofiel

Plaats informatie over de leaseprovider, met bedrijfsomschrijving, maximaal vier afbeeldingen, adres, website, contactgegevens, veelgestelde vragen, een slogan en een formulier voor algemene informatievragen.

Digifresh beheert en publiceert het profiel. Klantwebsites die dezelfde leaseprovider gebruiken kunnen hetzelfde openbare profiel plaatsen. Kies bij verschillende leaseproviders steeds het profiel van de juiste provider. Het openbare Leaseprofiel-iframe vereist geen dealer-ID, integratie-ID of geheime API-sleutel. De REST API gebruikt wel jouw integratie-ID en geheime API-sleutel.

Leaseprofiel via REST API

Gebruik GET /api/v1/leaseprofiel/ met jouw integratie-ID en geheime API-sleutel op de server. De API bepaalt de leaseprovider uit die integratie; stuur geen provider-ID mee. Het antwoord bevat profile met provider_id, name, headline, description, phone, email, address, postal_code, city, website, slogan, images (maximaal vier), logos en faq (items met question en answer).

Profiel opvragen — server-side
GET https://leasemodule.nl/api/v1/leaseprofiel/
X-LeaseModule-Integration: JOUW_INTEGRATIE_ID
X-LeaseModule-API-Key: JOUW_GEHEIME_API_SLEUTEL

Bouw de profielpagina zelf op en behandel tekstvelden als tekst (escape de inhoud vóór HTML-weergave). Afbeeldingen worden als volledige HTTPS-URL teruggegeven. Een niet gepubliceerd profiel geeft HTTP 404.

Alternatief: openbaar iframe

Voorbeeld — gebruik de provider-ID en volledige installatiecode van Digifresh
<iframe id="lm-leaseprofiel"
  src="https://leasemodule.nl/api/leaseprofiel/?provider_id=JOUW_PROVIDER_ID"
  title="Over onze leasepartner" width="100%" height="850"
  style="border:0;width:100%" loading="lazy"></iframe>
<script>
(function () {
  var frame = document.getElementById('lm-leaseprofiel');
  window.addEventListener('message', function (event) {
    if (event.origin !== 'https://leasemodule.nl' ||
        event.source !== frame.contentWindow ||
        !event.data || event.data.type !== 'leasemodule:height') return;
    var height = Number(event.data.height);
    if (Number.isFinite(height) && height >= 100 && height <= 20000)
      frame.style.height = Math.ceil(height) + 'px';
  });
})();
</script>

Plaats dit bijvoorbeeld op een pagina 'Over onze leasepartner'. Controleer logo's, afbeeldingen, contactknoppen en FAQ op desktop en mobiel. Gepubliceerde wijzigingen worden automatisch zichtbaar op de aangesloten websites. Algemene informatievragen via het iframe worden naar het ingestelde profiel-e-mailadres gestuurd. Het formulier vereist actieve centrale reCAPTCHA v2-instellingen en gebruikt daarnaast een honeypot. Bij REST API-weergave bouwt de website de interface zelf; de GET-profielroute verwerkt geen formulierinzendingen.

Testen en livegang

  • Controleer de berekening voor een btw-auto en een margeauto.
  • Controleer zakelijke en particuliere producten die zijn geactiveerd.
  • Controleer de verwerking van de aanvraag en de koppeling aan het juiste autobedrijf.
Terug naar alle handleidingen →