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:
-
Request generated description (Essential)
For each check, there will be three ways that we will validate the check is passed:
-
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
Generating a description (Essential)
To use Co-Driver to generate a description for a stock record, you will need to make a POST request to the Co-Driver API with the description query string parameter set to true.
Test | How we'll check it |
Able to fulfil mandatory checks in the Stock update functionality in the Stock Updates capability Go Live checks | |
Able to call the Co-Driver API with the description=true parameter to get a description for a Stock ID | Call log validation |
Co-Driver is only called once at a time, and should not be called multiple times in a row to generate a description | Call log validation |
The user can edit the description returned by the Co-Driver API, to correct any potential mistakes that have been generated incorrectly | Demonstration |
The user must validate that the description is correct and that they are satisfied before using the Stock API to update the description on Auto Trader | Call log validation and demonstration |
Optional checks | |
Able to allow the user to regenerate a description if they are not happy with the initial description generated by the Co-Driver API | Demonstration |