API for interacting with sites and content hosted on Dealer.com's Content Management System.
End points should include the API version number as part of the path. New versions will be published in the Release Notes
| Action | Http Method | URL |
|---|---|---|
| Create Page | POST | /api/{version}/pages |
| Delete Page | DELETE | /api/{version}/pages |
| Get Page | GET | /api/{version}/pages |
| Update Page Contents | PATCH | /api/{version}/pages |
Calls requires an API Key that can be provided to you by request. The API key request should contain a list of siteIds to be associated with your key. Once given your API you should include this key in your request headers to authenticate.
- Code: 401 Unauthorized
{
"message": "Unauthorized"
}
- Code: 403 Forbidden Content:
"Message": "User is not authorized to access this resource with an explicit deny"
}
TODO: create/link to getting started guide
This api is CORS enabled.
All calls through the API are subject to rate limiting. Your calls to the API should be prepared to handle retry / load shedding responses. TODO: create/link to page with retry examples
Issues with this API can be reported by opening a GitHub Issue.
This API is currently under development and subject to change.