User-facing calls are all hosted on *.ilsa.cloud and require no authentication. Privileged operations, like the examples below, are handled by a different API: the Hexon API. Calls to this API should only be performed from an environment you control, i.e. your server and not the browser of the visitor.

https://api.hexon.nl/ilsa/api/v1/rest/ is the starting point of the full documentation with all features. We’ll highlight the most important pieces here.

The Hexon API supports multiple types of authentication, with HTTP Basic Authentication being the simplest.

Contact us to get your username and password.

https://api.hexon.nl/ilsa/api/v1/restdoc/objects

If you want to remove a vehicle from your site (for example if it violates your terms) you can do so with this call. In DV the advertiser will see their listing was rejected.

POST https://api.hexon.nl/ilsa/api/v1/rest/objects/12345/delete
Authorization: Basic ...
Content-Type: application/json

{"reason":"other"}

https://api.hexon.nl/ilsa/api/v1/restdoc/objects

If you offer your users to reserve a vehicle, you can track the state by using this call.

POST https://api.hexon.nl/ilsa/api/v1/rest/objects/12345/reserve
Authorization: Basic ...
Content-Type: application/json

{"reference":"whatever-you-want"}

This will change metadata.has_reserved and metadata.reservation_reference accordingly.

To cancel a reservation:

POST https://api.hexon.nl/ilsa/api/v1/rest/objects/12345/cancel_reservation
Authorization: Basic ...

ILSA will relay these signals back to DV, which in turn will inform the VMS of the advertiser, allowing the VMS to act accordingly.

TIP

Note the difference between metadata.has_reserved (you marked the vehicle as reserved) and sales_conditions.reserved (the advertiser or VMS marked the vehicle as reserved).

By default, reserved vehicles will not be automatically removed from your site. Set up a static filter if you don’t want to show reserved vehicles.

https://api.hexon.nl/ilsa/api/v1/restdoc/objects

If a vehicle has been sold through your platform, for example if you are selling the vehicle on behalf of the advertiser, you can mark it as such with this call. This will set metadata.has_sold to true (making sure the listing won’t be shown anymore), and stores the reference you passed in metadata.sold_reference.

POST https://api.hexon.nl/ilsa/api/v1/rest/objects/12345/sold
Authorization: Basic ...
Content-Type: application/json

{"reference":"whatever-you-want"}

WARNING

If you don’t offer a “Buy now” feature, but you believe the vehicle has been sold and should no longer be advertised, for example based on feedback received by your users, use the remove call instead.

ILSA will also inform DV, which in turn will inform the VMS of the advertiser, so they can act accordingly. For example by removing the vehicle from other listing sites as well.

TIP

Note the difference between metadata.has_sold (you marked the vehicle as sold) and sold (the advertiser or VMS marked the vehicle as sold). Both (by default) will result in the vehicle being removed from your site.