diff --git a/13/umbraco-engage/.gitbook/assets/umbraco-engage-api.png b/13/umbraco-engage/.gitbook/assets/umbraco-engage-api.png new file mode 100644 index 00000000000..d08d1733751 Binary files /dev/null and b/13/umbraco-engage/.gitbook/assets/umbraco-engage-api.png differ diff --git a/13/umbraco-engage/developers/headless/README.md b/13/umbraco-engage/developers/headless/README.md index 49bbf8f4440..6db7d37ab9e 100644 --- a/13/umbraco-engage/developers/headless/README.md +++ b/13/umbraco-engage/developers/headless/README.md @@ -6,14 +6,14 @@ description: >- # Headless -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. +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. ## Requirements -To install Umbraco.Engage.Headless, ensure the following: +To install Umbraco.Engage.Headless, ensure the following prerequisites: -* Umbraco v12 or higher is required to integrate with the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api). -* Enable the [Umbraco Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#enable-the-content-delivery-api) with the following configuration setting: +* Umbraco v13 is required to integrate with the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api). +* Enable the [Umbraco Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#enable-the-content-delivery-api) by adding the following configuration setting in the `appsettings.json` file: ```json { @@ -31,9 +31,9 @@ To install Umbraco.Engage.Headless, ensure the following: To install the Umbraco Engage Headless API, follow these steps: -1. Install the Umbraco.Engage.Headless package: +1. Install the `Umbraco.Engage.Headless` package: -* **Using an IDE:** Install the Umbraco.Engage.Headless package from NuGet in Visual Studio, JetBrains Rider. +* **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: @@ -62,4 +62,6 @@ builder.CreateUmbracoBuilder() 3. Rebuild and run your site. 4. Navigate to **/umbraco/swagger** in your browser. -5. From the top right definition dropdown, check for the **Umbraco Engage Marketing API.** +5. Check for the **Umbraco Engage API** from the top right definition dropdown. + +![Umbraco Engage API](../../.gitbook/assets/umbraco-engage-api.png)