ÃÛ¶¹ÊÓƵ

DocumentationAEM as a Cloud ServiceUser Guide

Delivery APIs delivery-apis

Last update: Thu Nov 28 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
Search Best Practices
Metadata Best Practices
Content Hub
Dynamic Media with OpenAPI capabilities
AVAILABILITY
Dynamic Media with OpenAPI capabilities guide is now available in PDF format. Download the entire guide and use ÃÛ¶¹ÊÓƵ Acrobat AI Assistant to answer your queries.

All approved assets available in Experience Manager assets repository can be searched and then delivered to integrated downstream applications using a Delivery URL.

Any changes made to approved assets in DAM, including version updates and metadata modifications, are automatically reflected in the delivery URLs. With a short Time-to-Live (TTL) value of 10 minutes configured for assets delivery via CDN, updates become visible across all authoring and published interfaces in under 10 minutes.

The following image illustrates the available delivery URLs:

Delivery APIs

The following table illustrates the usage of the various available Delivery APIs:

Delivery API
Description
Returns the web-optimized binary representation of the asset in requested output format based on the asset ID sent in the request. In addition, you can define various image modifiers such as, width, height, rotate, flip, quality, crop, format, and smart crop. See the for supported formats and image modifiers.
ÃÛ¶¹ÊÓƵ recommends using this API for all image format types.
Convenience API that applies defaults to web-optimized binary representation of the asset returned in the response. The defaults include a standard JPEG/WEBP format, quality => 65, and width => 1024.
Returns the originally uploaded binaries for the asset. ÃÛ¶¹ÊÓƵ recommends using this API for document format types and SVG images.
Returns the asset rendition’s bitstream available on AEM Assets authoring environment based on asset ID and rendition name sent in the request.
Returns the properties associated to an asset, such as, title, description, CreateDate, ModifyDate, and so on.
Returns the player container for the video asset. You can embed the player in to an iframe HTML element and play the video.
Returns the playback manifest file for the specified video asset in the selected output format. You must build a custom player capable of adaptive streaming through HLS or DASH protocols to be able to pull the playback manifest file and play the video.
NOTE
  • , are available to you as a limited availability feature. To get access, .
  • Smart Crop is not available with Assets Prime.

Delivery APIs endpoints delivery-apis-endpoint

The API endpoints vary for each delivery API. For example, the API endpoint for Web-optimized binary representation of the asset in the requested output format API is:
https://delivery-pXXXX-eYYYY.adobeaemcloud.com/adobe/assets/{assetId}/as/{seoName}.{format}

The delivery domain is similar in structure to the Experience Manager author environment’s domain. The only difference is replacing the term author with delivery.

pXXXX refers to the program ID

eYYYY refers to the environment ID

See for more information.

Delivery APIs request method delivery-api-request-method

GET

Delivery APIs header deliver-assets-api-header

You need to provide the following details while defining a header in the Delivery APIs header:

headers: {
      'If-None-Match': 'string',
      Authorization: 'Bearer <YOUR_JWT_HERE>'
    }

To invoke the Delivery APIs, an IMS token is required in the Authorization details to deliver a restricted asset. The IMS token is fetched from a technical account. See Fetch the AEM as a Cloud Service Credentials to create a new technical account. See Generating the access token to generate the IMS token and use it appropriately in the Delivery APIs request header.

To view request samples, response samples, and response codes, see .

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab