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:
- Search finance options (Essential)
- Filter monthly price (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
Search finance options (Essential)
To search for finance examples with a dealer's stock, make a GET request with the financeOption parameter included.
The financeOption parameter is made up of the mileage, deposit, and term separated by underscores.
Good to know: Stock will only show if a finance example can be given based on the finance options provided.
| 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 get stock with finance examples via the Search API | Call log validation and demonstration |
|
Able to adjust the finance options of the request using valid values in our API developer documentation |
Call log validation and demonstration |
Filter monthly price (Enhanced)
To filter the results of a finance search based on a monthly price, you must make a GET request with the financeOption parameter and either one or both of the minMonthlyPrice or maxMonthlyPrice parameters.
| Test | How we'll check it |
|
Able to include both monthly price filters of the request to filters finance search results to a monthly price range |
Call log validation and demonstration |