API documentation

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

	title	slug / id
portal	aiways.nl	aiways-website
location	Blue Architect	blue-architect
car	Peugeot e-208	cde4a339-4705-4a37-b513-f6a8638f902d
collection	X1 xDrive 25e	x1-xdrive-25e
contract_types	['fol', 'flz', 'flp']	['nol', 'fol', 'pl', 'flz', 'flp', 'kp']
calculation_id	a010600002UIQ3QAAX	custom
exports	criteo campaign sitemap brand collection

 

description	call	example
Get offers This call returns a dataset of 6 models of all the active brands including active models of the current active dataset ordered randomly. The call also provides detailed information of the model like the from_price, an image and car count. This query is optimized for the frontpage of the website in order to show detailed information based on random offers.	URL /api/get_offers/ TYPE GET URL PARAMS -- CACHE TIME 2 min
Get all models This call returns a dataset of all the active brands including active models of the current active dataset. The call also provides detailed information of the model like the from_price, an image and car count.	URL /api/models/ TYPE GET URL PARAMS brand_id, min_car_count, limit, order CACHE TIME 15 min
Get model This call returns active cars for a given model (and so a brand). Per car some detailed information is available, like image, color, price, etc.	URL /api/model/3ce66fc8-eadb-4825-bb85-2dd18d408e56/ TYPE GET URL PARAMS model_id CACHE TIME 15 min
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/11f8830b-72bf-4d13-94c9-bbf45cd0cf2b/ TYPE GET URL PARAMS collection_id CACHE TIME 15 min
Get collections for portal for brand This call returns the collections for a given portal and a given brand. Per collection detailed information is available, like image, price, etc.	URL /api/collections/portal/lease-e-website/brand/f97d5958-43ff-4f6c-b885-91aede41e83b/ TYPE GET URL PARAMS portal_slug, brand_id CACHE TIME 15 min
Get collections for portal This call returns the collections for a given portal. Per collection detailed information is available, like image, price, etc.	URL /api/collections/portal/lease-e-website/ TYPE GET URL PARAMS portal_slug CACHE TIME 15 min
Get collections for brand This call returns the collections for a given brand. Per collection detailed information is available, like image, price, etc.	URL /api/collections/brand/f97d5958-43ff-4f6c-b885-91aede41e83b/ TYPE GET URL PARAMS brand_id CACHE TIME 15 min
Get models for a brand This call returns active models if there are current active cars linked.	URL /api/models/f97d5958-43ff-4f6c-b885-91aede41e83b/ TYPE GET URL PARAMS brand_id, min_car_count, limit, order CACHE TIME 15 min
Get cars for portal This call can be used to fetch multiple cars for a portal.	URL /api/cars/portal/lease-e-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/cde4a339-4705-4a37-b513-f6a8638f902d/ TYPE GET URL PARAMS car_id CACHE TIME 15 min
Calculate Financial Lease price This call can be used to calculate a Financial Lease price. Important is only car_id is required, all other params have defaults.	URL /api/calculate/car/cde4a339-4705-4a37-b513-f6a8638f902d/flz/ TYPE GET URL PARAMS car_id, profit_margin, insurance_percentage, invest_amount, down_payment, result, contract_time, interest 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/cde4a339-4705-4a37-b513-f6a8638f902d 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/cde4a339-4705-4a37-b513-f6a8638f902d 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