To get live API access, your integration must pass certain tests. This will make sure that it meets our technical standards and best practices.
For each capability, the tests cover Essential and Enhanced functionalities. Your integration must pass at least one of the Essential functionality tests to get live access.
We recommend using the Enhanced functionalities to allow dealers to get the full benefits of the service.
We'll cover the tests for the following functionalities:
- Retrieve competitor search URL (Essential)
-
- Vehicle lookup competitor stock search URL (Essential)
- In-stock competitor stock search URL (Essential)
-
- Perform competitor stock search (Essential)
There are three ways we check that tests are successful:
- Demonstration - We will expect you to show us your code or your UI
- Call log validation - We will check your API calls to our service to make sure the call is made correctly
- Database check - We will check our database to see whether the correct attribute has been updated
Retrieve competitor search URL (Essential)
There are two ways to look up a vehicle’s competitor search URL. You can use either Stock API or Vehicle API to get this URL.
Vehicle lookup competitor stock search URL (Essential)
When looking up a vehicle via the Vehicles API, at a minimum, you will need to make sure that you are passing the advertiser ID that the lookup is on behalf of, and the registration that you are doing a lookup on.
If you would like to get a competitor stock search URL for a vehicle not already in your stock, then you can do this by including the competitors=true parameter in the query string of your Vehicles API GET request.
| Test | How we'll check it |
|
Able to fulfil mandatory checks in the Vehicle registration lookup functionality in the Vehicle Taxonomy capability Go Live checks |
|
|
Able to get the competitor search URL of a stock record via the Vehicles API. This should only be used for vehicles not in your stock. |
Demonstration and call log validation |
In-stock competitor stock search URL (Essential)
If you would like to get a competitor stock search URL for a vehicle in your stock, include the competitors=true parameter in the query string of your Stock API GET request.
| Test | How we'll check it |
|
Able to fulfil mandatory checks in the Baseline stock functionality in the Stock Sync capability Go Live checks |
|
|
Able to get the competitor search URL of a stock record via the Stock API |
Demonstration and call log validation |
| Optional checks | |
|
Able to get a competitor search URL for one stock ID rather than for all stock records via the Stock API. This can be done by using the stockId parameter to filter. |
Call log validation |
Perform competitor stock search (Essential)
With the competitor search URL you got from either the Vehicles API or Stock API, use this pre-filled URL to fetch competitor stock data for the specified vehicle. You will need to perform a Stock API GET request using the competitor search URL.
| Test | How we'll check it |
|
Able to get competitor stock data for a vehicle using the competitor search URL via the Stock API |
Demonstration and call log validation |
|
Include pagination in the request using a maximum page size of 20. You can only get a total of 200 competitor vehicles with the competitor search URL. |
Call log validation |
|
Calls are made on demand when the user wants to get competitor stock, and not made as a bulk request for several vehicles at the same time |
Call log validation |
| Optional checks | |
|
Able to modify the filters on a request to increase or decrease the results |
Demonstration and call log validation |