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:
Installing the Umbraco Engage Headless API
To install the Umbraco Engage Headless API, follow these steps:
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:
Updating Startup.cs
To update the Startup.cs file, follow these steps:
Open your
Startup.cs
file.Locate the ConfigureServices method.
Add the line
.AddMarketingApiDocumentation()
after.AddDeliveryApi()
. Your ConfigureServices method should look like this:
Rebuild and run your site.
Navigate to /umbraco/swagger in your browser.
From the top right definition dropdown, check for the Umbraco Engage Marketing API.
Last updated