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:
- Vehicles lookup retail rating (Essential)
- Vehicle metrics retail rating (Essential)
- Location-adjusted retail rating (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
Vehicle lookup retail rating (Essential)
When looking up a vehicle’s Retail Rating via the Vehicles API, you will need to make sure that your request includes:
- The advertiser ID that the lookup is on behalf of
- The registration that you are doing a lookup for
- The odometerReadingMiles parameter with the mileage of the vehicle
- The vehicleMetrics=true parameter.
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 retrieve the Retail Rating of a vehicle via the Vehicles API. This can be done for all vehicles, whether they are in stock or not. |
Call log validation |
|
Request is included within your initial Vehicle API request, this should not be done in a second call |
Demonstration |
|
Able to handle a 200 response with null valuations, and present a message back to the user |
Demonstration |
| Calls should be completed once per day, as Retail Rating is only updated daily | Demonstration and call log validation |
Vehicle metrics retail rating (Essential)
You can also access Retail Rating via the Vehicle Metrics API using a POST request.
Requests to this endpoint will need to include an advertiser ID in the query string, as well as, at a minimum, derivative ID, first registration date and odometer reading miles in the request body.
| Test | How we'll check it |
| Able to request Retail Rating for a derivative ID via the Vehicle Metrics API | Demonstration and call log validation |
| Able to handle a 200 response with no Retail Rating, and present a message back to the user | Demonstration |
| Calls should be completed once per day, as Retail Rating is only updated daily | Demonstration and call log validation |
| Optional checks | |
|
Able to use the Vehicle Taxonomy capability to retrieve a derivative ID. Relevant mandatory checks should be fulfilled in the Vehicle Taxonomy Go Live checks |
Demonstration |
Location-adjusted retail rating (Enhanced)
You can also request Retail Rating to be location-adjusted, across multiple advertiser IDs via the Vehicle Metrics API.
Requests should include a single advertiser ID in the query string, either a default advertiser ID or the current advertiser ID the vehicle is at.
The body of the request should then include:
- The derivative ID
- First registration date
- Odometer reading miles
- An array of advertiser IDs that you want to get location-adjusted Retail Ratings for
| Test | How we'll check it |
| Able to get location-adjusted Retail Rating, including up to a maximum of 20 advertiser IDs in the body of the request | Demonstration and call log validation |
| If requesting for more than 20 locations, these are done in multiple requests | Call log validation |