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 response metrics (Essential)
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 response metrics (Essential)
To get the response metrics on behalf of a dealer, you must make a GET request to the stock endpoint, including the advertiser ID and the responseMetrics=true parameter.
| Test | How we'll check it |
|
Able to fulfil mandatory checks in the Baseline stock functionality in the Stock Sync capability Go Live checks |
|
|
Successfully get response metrics from the Stock API for an advertiser, for at least one of the following data points:
|
Demonstration and call log validation |
| Calls should be completed once per day, as response metrics are only updated daily | Demonstration and call log validation |