The calls below are all user-facing and hosted on *.ilsa.cloud and require no authentication. Privileged operations are handled by the Hexon API.

You can learn more about the API by using the API Explorer or by inspecting the OpenAPI specification / swagger.

This API returns the options for each field you want to show. You need to list each field you want to receive the options for in the _fields parameter. This is to support different pages on your site showing different sets of fields. Before you can use a field as a field, you must configure it as such in your configuration.

For each field you’ll receive a sorted list of options, which can easily be rendered into <option>s of a <select>. For each option you receive it’s unique identifier (key), the translation (display_value) and a count, which indicates how many search results remain if the visitor were to choose this option.

For range fields, you’ll receive two lists of options. They are the same except for their count.

Whenever the visitor selects an option, you can request the dropdowncontents again and pass all the filters to get updated counts for each option.

The response also contains the total number of results if you were to search with the given filters.

This API returns a list of vehicles matching the given filters (as well as the number of results as if no _limit was applied). You can use _order to sort the vehicles and _offset and _limit for pagination. The returned vehicle will carry all the fields you’ve configured for the chosen _fieldset.

This API returns a single vehicle. You’ll only get the fields configured in the chosen _fieldset.

In your fieldset you should configure the automatic field sections[] which contains all information we have about this vehicle in an easy to render structure. All fields are grouped in sections, and sometimes even subsections (for example we might create one subsection for each sales contact). For most sections there is exactly one subsection with no key or title. In the future we can easily add new fields to these sections as support is added to DV and/or ILSA. The text field is for example used in the remarks section and contains the remarks from the advertiser. Feel free to add your own logic about field ordering or hiding fields, but beware we might add or change fields without notice. If you want the contents of a specific field, you should request it with your fieldset rather than relying on finding it in the sections data.

Any equipment or delivery_packages not available in the requested _locale will be hidden if the advertiser has not supplied it. In the sections data entries will simply not be added if the translation isn’t supplied. In the structural data those fields will be omitted. (Below it’s documented which fields are locale specific, and thus might be hidden if no translation is available.)

INFO

Note that this API is not enabled on all instances. Contact us to get it enabled.

This API returns the information about two or more vehicles including for each property which vehicle is better or worse. In the vehicles response field you get the fields from the chosen _fieldset. The sections structure follows the same layout as returned from /vehicle, but has information about each of the vehicles. Arrays of vehicles in the response are in the order you requested with the id parameter.

[beta] For each property of a vehicle we classify it as best, worst, neither, equal, unset or unordered. These rankings are beta and subject to change.
best
This vehicle is the best in this aspect. Multiple vehicles might be the best.
worst
This vehicle is the worst in this aspect. Multiple vehicles might be the worst.
neither
This vehicle is neither the best nor the worst. Is only used if you compare 3 or more vehicles.
equal
All vehicles have the same value for this property.
unset
We don’t know this property of this vehicle (raw is null).
unordered
We can’t say whether this is better or worse than other values.

This API sends a lead to the advertiser. Most fields are optional and/or only relevant for specific lead_types. We expect you to also send a notification to the advertiser yourself, because if DV doesn’t have a connection to the lead management system of the advertiser, the lead will only be used for statistics and won’t be delivered to the advertiser.