Skip to content

Engage: Added missing image to Headless article #6678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 19, 2024
Merged

Engage: Added missing image to Headless article #6678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13346a9
Added image
eshanrnh Nov 18, 2024
c613893
Update 13/umbraco-engage/developers/headless/README.md
eshanrnh Nov 19, 2024
40019e3
Incorporated review comment
eshanrnh Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added 13/umbraco-engage/.gitbook/assets/umbraco-engage-api.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 9 additions & 7 deletions 13/umbraco-engage/developers/headless/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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:
Expand Down Expand Up @@ -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)
Loading