Headless

Discover how to integrate Umbraco.Engage.Headless package with Umbraco 12.0+ for a Content Delivery API.

Umbraco Engage has a Umbraco.Engage.Headless package that can be installed to integrate with Umbraco 12.0+. Headless Content Delivery API, enabling personalized content, A/B tests, and segmentation.

Requirements

To install Umbraco.Engage.Headless, ensure the following:

• Umbraco v12 or higher is required to integrate with the Content Delivery API.

• Enable the Umbraco Content Delivery API with the following configuration setting:

{
"Umbraco": {
    "CMS": {
        "DeliveryApi": {
            "Enabled": true
        }
    }
}
}

Installing the Umbraco Engage Headless API

To install the Umbraco Engage Headless API, follow these steps:

1. Install the Umbraco.Engage.Headless package:

• Using an IDE: Install the Umbraco.Engage.Headless package from NuGet in Visual Studio, JetBrains Rider.

• Using the command line:

  • Navigate to your Umbraco website root folder in your terminal.

  • Run the following command:

dotnet add package Umbraco.Engage.Headless

Updating Startup.cs

To update the Startup.cs file, follow these steps:

1. Open your Startup.cs file.

2. Locate the ConfigureServices method.

3. Add the line .AddMarketingApiDocumentation() after .AddDeliveryApi(). Your ConfigureServices method should look like this:

public void ConfigureServices(IServiceCollection services)
{
    services.AddUmbraco(_env, _config)
        .AddBackOffice()
        .AddWebsite()
        .AddDeliveryApi()
        .AddMarketingApiDocumentation()
        .AddComposers()
        .Build();
}

4. Rebuild and run your site.

5. Navigate to /umbraco/swagger in your browser.

6. From the top right definition dropdown, check for the Umbraco Engage Marketing API.