Skip to main content

Adobe Experience Manager (AEM) Integration: Technical Details Supplement

Learn about the additional technical requirements for the Adobe Experience Manager (AEM) Assets integration. Use this guide to configure the integration for your AEM deployment.

When to Use This Article

This article is intended for administrators with custom AEM deployments.

Review this article if you need to:

  • Configure a custom asset URL.

  • Use an Author instance as your endpoint.

  • Configure a Content Delivery Network (CDN) URL.

  • Understand how Knak builds public asset URLs.

For standard installation steps, see Setting up the Adobe Experience Manager integration.


Access Requirements

Knak searches Adobe Experience Manager (AEM) assets by using two application programming interfaces (APIs):

The Endpoint URL configured in Knak is the location where Knak sends requests to these APIs.

Network Access

If your AEM environment restricts inbound traffic, allow Knak to access your Endpoint URL.

Contact Knak Support if you need the list of Knak IP addresses for allowlisting.

Supported Endpoint Types

You can configure either:

  • An Author instance (recommended)

  • A Publish instance

Most deployments use an Author instance. When an Author instance is configured, Knak resolves public asset URLs automatically using one of the methods below.


Configure Public Asset URLs

Knak supports two methods for generating public asset URLs.

Option 1: Use a Public URL Prefix

Use this option if your assets are publicly available from a single host, such as a Content Delivery Network (CDN).

Set the Public URL Prefix in the integration settings. Knak builds each asset URL by appending the asset's Java Content Repository (JCR) path to the configured prefix.

Format

<Public URL Prefix>/<JCR Path>

Example

If your public asset URLs follow this format:

https://my.cdn.com/assets/<jcr-path>.jpg

Set the Public URL Prefix to:

https://my.cdn.com/assets

Knak automatically appends each asset's JCR path to create the final public URL.

Option 2: Use JCR Properties

If you do not configure a Public URL Prefix, Knak uses the URLs returned by the AEM Assets API and Query Builder API.

If Knak detects an Author instance, such as:

Knak attempts to generate the corresponding Publish instance URL by updating the port number or hostname.

Custom Asset URL Configurations

Some organizations use custom methods to publish assets. If your deployment stores public asset URLs in different Java Content Repository (JCR) properties, Knak can support this configuration.

Contact Knak Support to discuss your specific implementation.


Deployment Considerations

Configuration

Recommendation

Endpoint URL

Use an Author or Publish instance. An Author instance is recommended for most deployments.

Public URL Prefix

Configure this when assets are served from a single public host or Content Delivery Network (CDN).

Custom asset URLs

Contact Knak Support if your organization uses custom JCR properties or a unique asset publishing workflow.


Need more help? Contact support via live chat using the chat bubble in the bottom right corner or email support@knak.com.

Did this answer your question?