API documentation

Onderstaande overzicht toont de API mogelijkheden. Ververs deze pagina voor random voorbeelden.

	title	slug / id
portal	aiways.nl	aiways-website
car	Ionieq5	0b005672-9e7c-41a0-88fa-31b4358d0db0
collection	Toyota bZ4X	toyota-bz4x
contract_types	['fol', 'flz', 'flp']	['nol', 'fol', 'flz', 'flp', 'prl', 'kp']
calculation_id	a010600002UIQ3QAAX	custom
exports	criteo campaign sitemap brand collection

description

call

example

Get collection
This call returns active cars for a given collection (and so a brand). Per car some detailed information is available, like image, color, price, etc.

URL	/api/collection/29f631fb-d562-4bde-ba9c-25c89b665b67/
TYPE	GET
URL PARAMS	collection_id
CACHE TIME	15 min

Get cars for portal
This call can be used to fetch multiple cars for a portal.

URL	/api/cars/portal/aiways-website/?ct=fol,flz,flp
TYPE	GET
URL PARAMS	portal_slug
CACHE TIME	15 min

Get a single car
This call can be used to fetch the full car data.

URL	/api/car/0b005672-9e7c-41a0-88fa-31b4358d0db0/
TYPE	GET
URL PARAMS	car_id
CACHE TIME	15 min

V2 \| Calculate FLz or FLp without a car
This call can be used to calculate FLz or FLp without a car.

URL	/api/v2/calculate/ct/flp-a/
TYPE	GET
URL PARAMS	flz, flp
CACHE TIME	15 min

V3 \| Get a single car
This call can be used to fetch the full car data in Algolia format.

URL	/api/v3/car/c/0b005672-9e7c-41a0-88fa-31b4358d0db0/
TYPE	GET
URL PARAMS	car_id
CACHE TIME	15 min

V3 \| Calculate Financial Lease price
This call can be used to calculate a Financial Lease price, both: flp and flz. Only car_id is required, all other params have defaults.

URL	/api/v3/calculate/c/0b005672-9e7c-41a0-88fa-31b4358d0db0/ct/flz/
TYPE	GET
URL PARAMS	car_id, fl_type, profit_margin, insurance_percentage, invest_amount, down_payment, result, contract_time, interest
CACHE TIME	nvt.

Calculate Financial Lease price
This call can be used to calculate a Financial Lease price, both: flp and flz. Only car_id is required, all other params have defaults.

URL	/api/calculate/car/0b005672-9e7c-41a0-88fa-31b4358d0db0/flz/
TYPE	GET
URL PARAMS	car_id, fl_type, profit_margin, insurance_percentage, invest_amount, down_payment, result, contract_time, interest
CACHE TIME	nvt.

Calculate Full Operation Lease price
This call can be used to calculate a Full Operation Lease price. Only car_id is required, all other params have defaults.

URL	/api/calculate/car/0b005672-9e7c-41a0-88fa-31b4358d0db0/fol/
TYPE	GET
URL PARAMS	car_id, mileage, contract_time
CACHE TIME	nvt.

Test-call for fetching a car from SalesForce
This call can be used to test fetching a car from SalesForce.

URL	/api/salesforce/fetch_advertised_vehicle/0b005672-9e7c-41a0-88fa-31b4358d0db0
TYPE	GET
URL PARAMS	car_id

Force car-data being updated to SalesForce
This call can be used to get the latest car data in SalesForce.

URL	/api/salesforce/enrich_advertised_vehicle/0b005672-9e7c-41a0-88fa-31b4358d0db0
TYPE	GET
URL PARAMS	car_id

Test-call for fetching a calculation from SalesForce
This call can be used to test fetching a calculation from SalesForce.

URL	/api/salesforce/fetch_calculation/a010600002UIQ3QAAX
TYPE	GET
URL PARAMS	car_id

Force calculation-data being updated to SalesForce
This call can be used to get the latest calculation data in SalesForce.

URL	/api/salesforce/enforce_update_calculation/a010600002UIQ3QAAX
TYPE	GET
URL PARAMS	calculation_id