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 public search adverts (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 public search adverts (Essential)
The Search API allows users to view an unrestricted search of vehicles advertised on Auto Trader. This can be performed dynamically through GET requests and allows integrators to use many filters to return very specific adverts that fit their criteria.
| Test | How we'll check it |
|
Able to fulfil mandatory checks in the Retrieve advert details functionality in the Search capability Go Live checks |
|
|
Able to fulfil mandatory checks in the Filter the results functionality in the Search capability Go Live checks |
|
|
Able to request data via the Search API, using searchType, pagination and advertisingLocation as minimum filters and return results to the user |
Call log validation and demonstration |
| Optional checks | |
|
If using this capability to power a manufacturer’s Used Vehicle Locator (UVL), the advertisingLocation=locatorWebsite parameter is included in all Search API calls |
Call log validation |
| Able to retrieve advertiser details from the Search API, to be able to display which advertiser the stock record is from where required | Demonstration |