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 trended valuations (Essential)
-
- Feature-adjusted trended valuations (Enhanced)
- Condition-adjusted trended valuations (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
Retrieve trended valuations (Essential)
With the Trended Valuations capability, you can get trended valuations for a vehicle. Trended valuations can provide historic and future valuations for up to six months in the past and future.
| Test | How we'll check it |
|
Able to get trended valuations from the Valuations API for at least one of the following markets:
|
Demonstration |
| Calls are made on demand when the user wants to view the trended valuation, and not made as a bulk request for several vehicles at the same time | Call log validation |
|
The start and end mileage used in the trended valuation call is appropriate for at least one of the following use cases:
|
Demonstration |
| Optional checks | |
|
Able to use the Vehicle Taxonomy capability to get a derivative ID - relevant mandatory checks should be fulfilled in the Vehicle Taxonomy Go Live checks |
Demonstration |
|
Able to adjust the start and end date for the trended valuation, using multiple requests if the number of dates for valuations requested is over 33 |
Demonstration |
|
Able to adjust the frequency returned in the trended valuation. For example, when requesting 30 days of valuations, you may do this with daily frequency, but when requesting 6 months of valuations, you may do this with monthly frequency |
Demonstration |
Feature-adjusted trended valuations (Enhanced)
Using the trended valuations endpoint, you can adjust these valuations for features that are on a vehicle, which will provide greater accuracy for the retailer when sourcing or appraising vehicles.
| Test | How we'll check it |
|
Able to get a feature-adjusted trended valuation via the Valuations API |
Demonstration and call log validation |
| All features need to be provided in the request, including both standard and optional | Demonstration |
Condition-adjusted trended valuations (Enhanced)
Using the trended valuations endpoint, you can also adjust these valuations for the condition of the vehicle. This will be useful when looking at a potential part-exchange vehicle, which could come in a range of conditions.
| Test | How we'll check it |
| Able to get condition-adjusted trended valuations by including a valid condition rating in the trended valuations request | Demonstration |
| Optional checks | |
|
Able to dynamically adjust the condition rating in your system, which will perform a new request for trended valuations for the selected condition |
Demonstration |