Optimizely CMP Open REST API
Describes concepts and resources for integrating an application using the API and Webhooks.
The Optimizely Content Marketing Platform (CMP) Open API and Webhooks are used by the following people to integrate applications:
- Developers and System Architects
- Product Owners/Managers for integrations
- Members of the IT team supporting the CMP team at your organization
- Technical leaders who are estimating the effort and feasibility of custom integrations
The following can help you in using the API and Webhooks:
- Knowledge of REST
- Knowledge of JSON
- Access to the Optimizely Content Marketing Platform
- A Client Application – that is, the application that will connect to CMP as a client and consume the API and Webhooks
The open API is served through https://api.welcomesoftware.com/v3. You should update your integrations to use the new base URL. The previous base URL: https://api.welcomesoftware.com/v3 will remain functional until further notice.
See also the following documentation:
- Optimizely Content Marketing Platform user guide
- Optimizely Content Marketing Platform Open API reference
What can the CMP Open API and Webhooks do?
The API library and Webhooks integrates with other applications in your MarTech ecosystem. You can use the Open API and Webhooks to achieve some of the following examples:
Synchronize assets with the Asset API and Webhooks (library)
The Asset API can synchronize supported assets with:
- The CMP library with an Optimizely Digital Asset Manager (DAM).
- Asset metadata between two systems.
- A Sales Enablement or Marketing Automation platform, including the metadata needed to sort, organize, and target those assets to specialized audiences in those systems.
The Asset API can send approved images from the CMP library to a specific folder in an image repository.
Manage external work with the Task API
The Task API can:
- Establish a link between a task step in CMP and a request ticket in another system. The link can let you monitor the progress of the ticket as it progresses through an external workflow.
- Collaborate during a workflow step with users in an external system during the content creation process.
- Defer a CMP workflow step approval to an external system for more complex legal reviews and compliance.
What is a successful connection/authorization?
A successful authorization is represented by an access_token. So whenever a client application successfully obtains an access_token for a CMP user, the authorization of that user for that client application is successful.
Why do I have to log in on the first access?
You need to log in so that the authorization server can associate you as the impersonated user for the generated authorization tokens (access_token and refresh_token). After client application generates the authorization tokens (access_token and refresh_token), the client application can periodically refresh the tokens without requiring re-authentication from the user.
The very first time that you establish a successful connection with the CMP Authorization Server, you are prompted to enter a user ID and Password because the browser is serving as the front-end to the CMP Authorization server. Subsequent attempts look for your client application to verify the access token.
- Rate limit – 10 requests per second per organization
- Request quota – 200,000 requests per month per organization
The following changes are backward compatible for Optimizely Content Marketing Platform (CMP) Open API:
- Adding a new endpoint or support for a new HTTP method
- Adding a new field to the response payload
- Adding a new optional field to the request payload
- Adding support for an optional query parameter
- Adding a value to an enum
- Adding support for a new optional request header
- Adding a new response header
Open API recommendation
Do not build URLs manually to fetch related resources. Instead, use the URLs provided in the links field in the response as-is without any manipulation.
Some documents may have a banner indicating experimental API.
Experimental APIs provide early access to APIs that are currently under development so that you have early access, can plan for implementing, and provide feedback.
The documentation may highlight new features, new data properties and data models, new filters, and other features specific to the new API.
These APIs are most often NOT operational and the documentation is subject to change until the APIs are fully released.
Experimental APIs generally require testing and development on your own applications before relying on them in your stable production environments.
Other Optimizely APIs
Class libraries are hosted on Optimizely World. APIs are hosted here.
- Optimizely Content Management System (CMS) and Optimizely Customized Commerce
- Optimizely Content Management System .NET API and libraries
- Optimizely Customized Commerce .NET API and libraries
- Content Delivery REST API reference (including Commerce Storefront REST API)
- Content Definitions REST API reference
- Content Management REST API reference
- Service API developer reference (Commerce Integration REST API)
- Optimizely Configured Commerce
- Optimizely Content Marketing Platform (CMP)
- Optimizely Data Platform (ODP)
- Optimizely Digital Experience Platform (DXP)
- Optimizely Experimentation
- Optimizely Search & Navigation
- Optimizely Campaign
Updated 10 days ago