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:
- View messages (Essential)
- Mark messages as read (Essential)
- Send messages (Enhanced)
-
- Send a new message (Enhanced)
- Reply to an existing message (Enhanced)
-
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
View Messages (Essential)
To view messages, make a GET request to the Messages API with the messages component ID of the deal you want to view messages for and the advertiser ID the deal belongs to.
| Test | How we'll check it |
|
Able to fulfil mandatory checks in the Baseline deals functionality in the Deal Sync capability Go Live checks |
|
| Able to call the Messages API with the message component ID to get message details of a deal | Call log validation |
| Calls should not be on a schedule, and should only be called when you receive a deal update notification, or when you are baselining a deal | Call log validation |
Mark Messages as read (Essential)
Messages can be marked as read via a PATCH request to the Messages API with the messages component ID in the URL and the advertiser ID in the query string. The request body should include the advertiserLastReadStatus attribute set to "Read".
| Test | How we'll check it |
|
Able to update the advertiserLastReadStatus to Read via the Messages API |
Demonstration and call log validation |
Send messages (Enhanced)
There are two functions when sending messages via the Messages API:
- Sending a new message
- Replying to an existing message.
They can both be completed with a POST request to the Messages API, including the messagesId for a reply, or the dealId to start a new conversation.
Send a new message (Enhanced)
| Test | How we'll check it |
| Ability to send a new message via the Messages API for a deal that does not currently have any messages | Demonstration and call log validation |
| Able to handle 400 error messages, which can occur when messages exceed the limit of 1500 characters or have forbidden text included in the body | Demonstration |
Reply to an existing message (Enhanced)
| Test | How we'll check it |
| Ability to respond to an existing message thread via the Messages API using the messages component ID and without creating a new message thread | Demonstration and call log validation |