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:
- Full Vehicle Check (Essential)
- Vehicle Check Report (Enhanced)
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
Full Vehicle Check (Essential)
A full vehicle check report can be requested using the Vehicles API by including the parameter fullVehicleCheck=true, as well as the dealer's advertiser ID and the vehicle's registration.
Most of our vehicle data that’s available in production will be available in sandbox for you to test with. But, newer vehicles and recent plate changes may not be.
| 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 request a full vehicle check, including fullVehicleCheck=true | Call log validation |
| Request is included within your initial Vehicle API request. This should not be done in a second call. | Demonstration |
|
Successful requests are not repeated on a schedule, as per our Vehicle Check Fair Usage Policy |
Call log validation and demonstration |
| Handle 403 errors where the advertiser ID does not have access to full vehicle check functionality and do not retry the call | Demonstration |
Vehicle Check Report (Enhanced)
A vehicle check report is a URL provided in each full vehicle check request and is downloadable as a PDF for end-users to view and store.
No additional parameters are needed to get this data. Only do this once during a vehicle's lifetime.
| Test | How we'll check it |
|
Able to request the vehicle check report PDF from the API URL provided in the report attribute of the check object returned in the Full Vehicle Check functionality |
Call log validation and demonstration |
| The vehicle check report is downloaded and stored as a PDF after being requested. This is then presented to the user in your system or as a download link for them to download. | Demonstration |