Harinarayanan
Apr 28, 2023
  451
(3 votes)

Content Delivery / Headless API Implementation

Hi,

I was new to the Headless (CD) implementation and learned with the help of existing resources and implemented it successfully for our requirement, so thought of sharing the implementation steps, in case anyone looking for step by step Content Delivery API implementation or Headless Implementation.

 Below are the tools/platforms I 've used for the implementation,

  1. CMS 11 
  2. React 
  3. ContentDeliveryApi.Cms 2.21.1

Step: 1

Install the below packages through the NuGet package manager.

<package id="EPiServer.ContentDeliveryApi" version="2.19.0" targetFramework="net48" />
  <package id="EPiServer.ContentDeliveryApi.Cms" version="2.21.1" targetFramework="net48" />
  <package id="EPiServer.ContentDeliveryApi.Core" version="2.21.1" targetFramework="net48" />
  <package id="EPiServer.ContentDeliveryApi.Forms" version="2.21.1" targetFramework="net48" />

Step: 2

Add the below configs into web.config, I'm not sure 100% knowledge on why this is required but either of those configs should be set to true, and the other one should be set to false, and not both of them set to true or false.

 <add key="episerver:contentdeliverysearch:maphttpattributeroutes" value="true" />
    <add key="episerver:contentdelivery:maphttpattributeroutes" value="false" />

Step: 3

Add a new Initialization module,

using EPiServer.ContentApi.Cms;
using EPiServer.ContentApi.Core.Configuration;
using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.ServiceLocation;
using System;
using System.Linq;

namespace Alloy.Web.Admin.ContentDeliveryApi
{
    [InitializableModule]
    [ModuleDependency(typeof(ContentApiCmsInitialization))]
    public class ContentDeliveryApiInit : IConfigurableModule
    {
        public void ConfigureContainer(ServiceConfigurationContext context)
        {
            context.Services.Configure<ContentApiConfiguration>(config => {
                config.Default().SetMinimumRoles(String.Empty);
            });
        }

        public void Initialize(InitializationEngine context)
        {
            //Add initialization logic, this method is called once after CMS has been initialized
        }

        public void Uninitialize(InitializationEngine context)
        {
            //Add uninitialization logic
        }
    }
}

Once you are done with the above steps you can re-build and run your solution to verify everything okay with the solution.

If you see your solution is working fine, then you can test Content Delivery API by accessing a site content with the help of Visual Studio Code(I feel it's a very feasible tool to access Headless content), In case if you don't have a REST Client in your Visual Studio Code please install the below Extension, It's really useful during our Headless implementation to test content.

Examples:

To get site definitions:

https://localhost:44300/api/episerver/v2.0/site/

To get your page content:

https://localhost:44300/api/episerver/v2.0/content/420003

To Expand the Content Area/Content reference within Content: 

To Get Language-Specific Content: 
In this way, your content is ready to access through Content Delivery API.
Step 4:
If you above all are working as expected we can move on to the next step.
The next will be creating the Content type, ViewModel, Controller, Basic view, and React development for fetching data and rendering data.
In my case had to create all of the above from scratch, maybe your case may differ. So I like to cover those parts in another blog. 
Please feel free to add your comments, questions, thoughts, or any missing steps.
Thanks for reading. Have a good day. 
Apr 28, 2023

Comments

Manoj Kumawat
Manoj Kumawat May 2, 2023 02:23 PM

Nice! Would be a good idea to write on Search & Navigation usages with ContentSearch.Api next ?

Please login to comment.
Latest blogs
Extended SelectionFactory

In one of my previous articles I described new Color Picker widget. Today I’d like to show another simple property. I prepared extended version of...

Grzegorz Wiecheć | Jun 7, 2023 | Syndicated blog

Unlock Creativity with Text Generation

Need fresh and innovative content ideas? The Epicweb.Optimizely.AIAssistant Addon has got you covered with its text generation feature. In this blo...

Luc Gosso (MVP) | Jun 6, 2023 | Syndicated blog

Breaking Language Barriers with Multilingual Text Translation

In today's globalized world, effective communication across languages is essential. The Epicweb.Optimizely.AIAssistant Addon makes language...

Luc Gosso (MVP) | Jun 6, 2023 | Syndicated blog

Optimizely Search & Navigation - Get autocomplete suggestions in right language

When you are using Optimizely Search & Navigation (Find) to help you generate autocomplete suggestions server side in a multi-language scenario it...

Allan Thraen | Jun 5, 2023 | Syndicated blog

Easy property inheritance in Optimizely CMS

Ever needed a way to inherit property values down through the page hierarchy in Optimizely CMS 12? Now there is an easy way to enable that.

Allan Thraen | Jun 5, 2023 | Syndicated blog

Content Bulk Edit

Bulk Edit is a plugin that allows to make changes to more than one Content at the same time. This can save time by simultaneously updating multiple...

Grzegorz Wiecheć | Jun 5, 2023 | Syndicated blog