Skip to content

Commit 5886eed

Browse files
authored
Merge pull request #6678 from umbraco/engage-headless-api
Engage: Added missing image to Headless article
2 parents 2a17d72 + 40019e3 commit 5886eed

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed
106 KB
Loading

13/umbraco-engage/developers/headless/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ description: >-
66

77
# Headless
88

9-
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.
9+
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.
1010

1111
## Requirements
1212

13-
To install Umbraco.Engage.Headless, ensure the following:
13+
To install Umbraco.Engage.Headless, ensure the following prerequisites:
1414

15-
* Umbraco v12 or higher is required to integrate with the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api).
16-
* 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:
15+
* Umbraco v13 is required to integrate with the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api).
16+
* 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:
1717

1818
```json
1919
{
@@ -31,9 +31,9 @@ To install Umbraco.Engage.Headless, ensure the following:
3131

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

34-
1. Install the Umbraco.Engage.Headless package:
34+
1. Install the `Umbraco.Engage.Headless` package:
3535

36-
* **Using an IDE:** Install the Umbraco.Engage.Headless package from NuGet in Visual Studio, JetBrains Rider.
36+
* **Using an IDE:** Install the `Umbraco.Engage.Headless` package from NuGet in Visual Studio or JetBrains Rider.
3737
* **Using the command line:**
3838
* Navigate to your Umbraco website root folder in your terminal.
3939
* Run the following command:
@@ -62,4 +62,6 @@ builder.CreateUmbracoBuilder()
6262

6363
3. Rebuild and run your site.
6464
4. Navigate to **/umbraco/swagger** in your browser.
65-
5. From the top right definition dropdown, check for the **Umbraco Engage Marketing API.**
65+
5. Check for the **Umbraco Engage API** from the top right definition dropdown.
66+
67+
![Umbraco Engage API](../../.gitbook/assets/umbraco-engage-api.png)

0 commit comments

Comments
 (0)