Getting started
All requests described should be made over HTTPS against https://api.contentor.com. Requests over regular HTTP are not accepted by the API.
Authentication
All requests to the API must be authenticated. Authentication is implemented via tokens, tokens can be created via the Customer Portal and is sent via a HTTP header:
Authorization: Bearer your-token-here
Formats and text encoding
This API uses JSON for both input and output. Replies are always of type application/json unless specified otherwise. Request that take a body are expected to be sent as application/json as well.
When you are sending data the server will refuse to process it unless you provide a valid Content-Type header.
The API will only consume and return text encoded as UTF-8. Ensure that your backend supports UTF-8 or that you can convert to and from the encoding needed.
Locales and languages
The API works with locales that are represented in the format of BCP 47, but currently only the language and region subtags are used. Region is used to help us with better localization, for example en-US indicates US English and en-GB indicates British English.
Your account determines which languages are available to you and these can be seen in the customer portal or you can contact us directly for more information.
Testing
The API supports testing via a special authentication token. Content requests created with the test token are created separately from other data and all fields in a content request will be automatically be assigned test values. This is intended to be used during development to test your integration with this API.