Headless
Discover how to integrate Umbraco.Engage.Headless package with Umbraco 12.0+ for a Content Delivery API.
Last updated
Was this helpful?
Discover how to integrate Umbraco.Engage.Headless package with Umbraco 12.0+ for a Content Delivery API.
Last updated
Was this helpful?
Umbraco Engage offers the Umbraco.Engage.Headless package for seamless integration with Umbraco 12.0 and later. This package enables access to the Headless Content Delivery API, enabling personalized content, A/B tests, and segmentation.
To install Umbraco.Engage.Headless, ensure the following prerequisites:
Umbraco v13 is required to integrate with the .
Enable the by adding the following configuration setting in the appsettings.json
file:
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 or JetBrains Rider.
Using the command line:
Navigate to your Umbraco website root folder in your terminal.
Run the following command:
To update the Program.cs file, follow these steps:
Open your Program.cs
file.
Add the line .AddEngageApiDocumentation()
after .AddDeliveryApi()
. Your CreateUmbracoBuilder
method should look like this:
Rebuild and run your site.
Navigate to /umbraco/swagger in your browser.
Check for the Umbraco Engage API from the top right definition dropdown.