Purpose and Capabilities
This Connector provides tools to interact with AEM’s Assets HTTP API for comprehensive digital asset management:Tool Name | Description | Example Inputs |
---|---|---|
aem_get_asset | Retrieves metadata and details of a specific asset. | asset_path , fields_to_include |
aem_list_assets | Lists assets in a folder with optional filtering. | folder_path , asset_type , limit , offset , search_query |
aem_search_assets | Searches for assets based on metadata criteria. | search_query , asset_type , tags , modified_since , limit |
aem_get_asset_renditions | Retrieves available renditions for an asset. | asset_path , rendition_types |
aem_download_asset | Downloads an asset or specific rendition. | asset_path , rendition_name , download_format |
aem_get_asset_metadata | Retrieves comprehensive metadata for an asset. | asset_path , metadata_schema |
aem_update_asset_metadata | Updates metadata properties of an asset. | asset_path , metadata_updates , metadata_schema |
aem_list_folders | Lists folders and subfolders in a given path. | parent_folder_path , recursive , limit |
aem_create_folder | Creates a new folder in the specified location. | parent_path , folder_name , folder_title , properties |
aem_get_asset_collections | Retrieves collections that contain a specific asset. | asset_path , collection_types |
aem_list_collections | Lists available asset collections. | collection_type , limit , offset |
aem_get_collection_assets | Retrieves assets within a specific collection. | collection_path , asset_types , limit |
aem_copy_asset | Copies an asset to a new location. | source_asset_path , destination_folder_path , new_asset_name |
aem_move_asset | Moves an asset to a different location. | source_asset_path , destination_folder_path , new_asset_name |
aem_get_asset_references | Finds where an asset is referenced or used. | asset_path , reference_types |
Prerequisites
- Adobe Experience Manager: An active AEM as a Cloud Service or AEM 6.5+ instance.
- API Access:
- AEM Assets HTTP API must be enabled and accessible.
- Appropriate user permissions for asset read/write operations.
- Service account or user authentication configured.
- Authentication:
- For AEM as a Cloud Service: Service credentials (JWT) or OAuth 2.0.
- For AEM 6.5+: Basic authentication or token-based authentication.
- Network Access: Connectivity to your AEM instance from the ACP environment.
- Understanding of AEM Concepts: Familiarity with AEM terms like Assets, Renditions, Collections, Metadata Schemas, and DAM folder structures.
Setup Instructions
For AEM as a Cloud Service
-
Create Service Account:
- Go to Adobe Developer Console (
https://developer.adobe.com/console
). - Create a new project and add the “Experience Manager Assets” API.
- Generate service account credentials (JWT).
- Download the private key and note the service account details.
- Go to Adobe Developer Console (
-
Configure AEM Permissions:
- In AEM, create a technical user account.
- Assign appropriate permissions to DAM folders and assets.
- Ensure the service account has read/write access as needed.
For AEM 6.5+
-
Create Technical User:
- In AEM User Management, create a service user account.
- Assign appropriate groups and permissions (e.g.,
dam-users
,content-authors
).
-
Configure Authentication:
- Set up token-based authentication or use basic authentication.
- Ensure the Assets HTTP API is enabled in your AEM configuration.
-
Test API Access:
- Use curl or Postman to test basic API operations.
- Verify authentication and permissions are working correctly.
Authentication
The AEM Connector supports multiple authentication methods:Service Account (AEM as a Cloud Service)
Basic Authentication (AEM 6.5+)
Token Authentication (AEM 6.5+)
Common Use Cases
- Asset Discovery: Search and retrieve marketing assets for campaigns and content creation.
- Content Automation: Automatically select appropriate images based on content context or metadata.
- Brand Compliance: Ensure only approved assets are used in marketing materials.
- Asset Workflow: Trigger asset reviews, approvals, or updates based on business events.
- Cross-Platform Integration: Sync assets between AEM and other marketing tools.
- Dynamic Content: Retrieve personalized assets based on customer segments or preferences.
Asset Path Structure
AEM assets are organized in a hierarchical folder structure:- Root Path:
/content/dam/
- Example Paths:
/content/dam/marketing/campaigns/2024/
/content/dam/products/electronics/
/content/dam/brand-assets/logos/
Supported Asset Types
- Images: JPEG, PNG, GIF, SVG, TIFF, WebP
- Videos: MP4, MOV, AVI, WebM
- Documents: PDF, DOC, DOCX, PPT, PPTX
- Audio: MP3, WAV, AAC
- Other: ZIP, AI, PSD, INDD
Rate Limits and Best Practices
- Performance: AEM API performance depends on asset size and server resources.
- Caching: Implement caching for frequently accessed assets and metadata.
- Batch Operations: Use efficient queries to minimize API calls.
- Asset Optimization: Consider using appropriate renditions for different use cases.
- Error Handling: Implement retry logic for network timeouts and server errors.
Security Considerations
- Access Control: Use principle of least privilege for service accounts.
- Asset Security: Be mindful of sensitive or confidential assets in automated workflows.
- Audit Logging: Enable AEM audit logging to track asset access and modifications.
- Network Security: Use HTTPS and secure network connections for all API calls.
- Token Management: Rotate authentication tokens regularly and store them securely.