Get started
Get started with Content Delivery API
In Optimizely Content Management System (CMS), you use built-in C# Razor helpers to render pages and blocks on a website. With the Optimizely Content Delivery API , you can use CMS in a headless mode, which means all pages and blocks are rendered by reading JSON data returned from a REST API.
Content Delivery API reference
Content Delivery API v3 Delivery API v2 https //docs. developers.
Quick start
Optimizely Content Delivery API consists of one main NuGet package, EPiServer. ContentDeliveryApi.
Breaking changes in version 3
A breaking change may cause a component to fail. When a breaking change is made to a signature of a method, class, or interface, the former signature is often kept intact but set as obsolete and may cause a warning message in Visual Studio.
Install Content Delivery API
The Optimizely Content Delivery API is installed through a set of NuGet packages, depending on the scenario in which the headless API is used. Install the NuGet packages in your solution using the NuGet Package Manager in Visual Studio or through command line See the general Install Optimizely instructions for information about setting up Visual Studio, requirements, and so on.
Configure Content Delivery API
You can configure the Optimizely Content Delivery API by working with an instance of ContentApiOptions . You can configure ContentApiOptions in ConfigureServices in startup.
Authenticate the API
Using the following methods, you can secure requests to the APIs with OpenID Connect and Bearer Tokens (JWT) with our library EPiServer. OpenIDConnect .
Content Delivery API and Commerce Connect
The EPiServer. ContentDeliveryApi.
Content Search API
The Content Search API exposes the ability to query for content in Optimizely Search & Navigation, providing robust filtering and sorting with OData syntax, with support for personalization, proper access control, and a feature for loading referenced content in the same request. For a complete list of valid endpoints and query parameters, see the Content Delivery API SDK https //world.
Use friendly URLs
In addition to using the regular endpoints, http //localhost 8080/api/episerver/v3. 0/content/6 , you can use a friendly name URL of a specific content item for data query http //localhost 8080/en/alloy-plan/ .