Content Definitions REST API
Explains what the Optimizely Content Definitions API is and what it contains.
What is Content Definitions API?
The Optimizely Content Definitions API is a REST API that lets system integrators and external clients remotely manage definitions, such as Content types, Property Groups, and Property Data Types without deploying code to the Optimizely application or using the admin user interface. Changes made through this API are reflected in the admin user interface and vice versa.
All settings available in the admin UI are not available through the API yet. For example, you cannot not manage websites, languages, or translations.
Since changes could be made to the same content types but from different sources, there may be conflicts that could affect existing content. To reduce the risk of conflicts, you should add version information to the content types. This can be done per content type or for all content types. See Semantic versioning.
The Content Definitions API developer guide has the following parts:
- Get started with Content Definitions API – Contains everything you need to get going with Content Definitions API, such as installation instructions, configuration options, and authorization.
- Content types – Contains detailed descriptions and instructions on how to communicate with the API and its different endpoints for managing content types.
- Content Definitions Manifest – Contains detailed descriptions and instructions on how to communicate with the API and its different endpoints for content definitions manifest.
- REST API reference – (OpenAPI/Swagger) documentation. Automatically generated documentation from the source code and contains descriptions of the endpoints and models, used for reference purposes.
Updated about 1 month ago