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:
- Stock update images (Essential)
-
- Upload images (Essential)
- Attach images (Essential)
-
- Stock update spin (Enhanced)
- Stock update video (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
Stock update images (Essential)
When updating media for a stock record, first you will need to upload images to our servers via the Images API, then attach them to a stock record via the Stock API.
Upload images (Essential)
If you have new images for your stock, you will need to upload the image via the Images API to get an image ID. You will need the image ID to attach the image to your stock record.
| Test | How we'll check it |
| Successfully upload an image via the Images API and store the image ID from the response against the image in your database | Call log validation |
Attach images (Essential)
Once you get the image IDs for your images, you will be able to attach the images to your stock record.
You will need to send a PATCH request via the Stock API with the stock ID of the stock record you want to update in the URL path, with an array of all image IDs for the stock record, not just the images that are being added.
Image IDs should be sent in the order that you want them to be shown on the Auto Trader website.
| Test | How we'll check it |
| Able to add and remove images from a stock record via the Stock API | Call log validation and database check |
| Able to change the image order on a stock record without reuploading the images via the Images API | Call log validation and database check |
Stock update spin (Enhanced)
If you would like to update the spin URL for a stock record, send a PATCH request to the Stock API with the stock ID included in the request path and the spin URL set in the request body.
| Test | How we'll check it |
| Able to update the spin URL for a stock record via the Stock API | Call log validation and database check |
Stock update video (Enhanced)
If you would like to update the video URL for a stock record, send a PATCH request to the Stock API with the stock ID included in the request path and the video URL set in the request body.
| Test | How we'll check it |
| Able to update the video URL for a stock record via the Stock API | Call log validation and database check |