Use vanity URLs vanity-urls

Use Dynamic Media with OpenAPI capabilities to transform your long asset delivery URLs into short, branded vanity URLs. Standard asset delivery URLs include system-generated asset UUIDs that make the delivery URL complex, hard to remember and share. Replace these asset UUIDs with simple identifiers (Vanity IDs) to generate a vanity URL. A vanity URL is a short, clean, and readable version of your complex delivery URL.

See the following URL formats to understand their difference:

Standard delivery URLs use aaid followed by a UUID, while vanity URLs use avid followed by a custom identifier (vanity identifier).

Use short and simple vanity identifiers, to make your vanity URL short, clean, readable, easy-to-remember and share. Use your brand name, product names, and relevant keywords as vanity IDs to boost your brand visibility and user engagement.

When your user clicks your vanity URL, Dynamic Media with OpenAPI automatically maps to the original asset location at ingestion time and resolve them properly at delivery time to server the asset to the user.

Learn to create Vanity URLs.

Standard Delivery URLs standard-urls

The standard Dynamic Media with OpenAPI asset delivery URL includes a unique system-generated identifier and follows the following format.

Format: https://delivery-<tenant>.adobeaemcloud.com/adobe/assets/urn:aaid:aem:<asset-uuid>/as/<seoname>.<format>

The standard delivery URL includes aaid (actual asset identifier) after urn: and a UUID between urn:aaid:aem: and /as/<seoname>.<format>.

Example: https://delivery-p30902-e145436.adobeaemcloud.com/adobe/assets/urn:aaid:aem:43341ab1-4086-44d2-b7ce-ee546c35613b/as/check.jpeg

In the above example, 43341ab1-4086-44d2-b7ce-ee546c35613b is the UUID.

Vanity URLs vanity-url

The vanity URLs includes a vanity identifier in place of asset UUID and follows the following format.

Format: https://delivery-<tenant>.adobeaemcloud.com/adobe/assets/urn:avid:aem:<vanity-id>/as/<seoname>.<format>

The vanity URL includes avid (actual vanity identifier) after urn: and your vanity ID between urn:avid:aem: and /<seoname>.<format>.

Example: https://delivery-p30902-e145436.adobeaemcloud.com/adobe/assets/urn:avid:aem:VanityCheck/as/check.jpeg

In the above example, VanityCheck is the vanity ID that replaced the UUID.

Explore key capabilities and benefits capabilities-and-benefits-of-vanity-urls

Using meaningful vanity IDs to customize the standard asset delivery URLs provides several advantages and measurable impact. Some of the key capabilities and benefits of vanity URLs include the following.

Key capabilities key-capabilities

  • URL customization: Replace long identifiers (asset UUIDs) in the delivery URL with shorter, brand-aligned alternatives to generate a cleaner delivery URL.
  • Real-time redirection: Vanity URLs redirect to original asset UUIDs at runtime without disrupting workflows. Users see clean URLs in the address bar while the system handles the technical routing.
  • Easy link management: Customize your vanity URLs at any time without affecting asset delivery performance.

Key benefits key-benefits

  • Enhances user experience: Clean and shorter vanity URLs are readable, user-friendly, easy to remember and share.

  • Improves user engagement: Branded URLs build user confidence and trust. Users are more likely to click professional, branded links, resulting in higher click-through rates.

  • SEO optimization: URLs that include relevant keywords improve search engine rankings and discoverability.

  • Enhanced brand visibility: Brand-specific URLs strengthen brand presence across all marketing channels, including email, social media, and advertising campaigns.
    Also, consistent use of branded URLs in all communications reinforces brand identity and recognition.

  • Campaign tracking and analytics: Use unique vanity URLs for different campaigns and channels to gain detailed insights into traffic sources and conversion performance.

Prerequisites prerequisites-for-creating-vanity-id

To create the vanity URL, ensure you have already approved the assets for public delivery.

Create Vanity URLs create-vanity-urls

Execute the following steps to create vanity URLs:

Set up asset metadata set-up-asset-metadata

Execute the following to set up the vanity ID in your asset’s metadata form:

  1. Navigate to the details page of the folder holding your assets for Dynamic Media with OpenAPI delivery.

  2. Edit that metadata form by doing one of the following:

    • Add a new metadata field and specify the required vanity ID as the value of that field.

    • Update existing field by replacing an existing metadata property’s value with the required vanity ID. Learn the best practices for creating the vanity ID.
      vanity ID
      Learn more about metadata schemas.

      note note
      NOTE
      • Use unique vanity IDs for each asset. Always verify that assets sharing the same metadata form have unique vanity IDs for DM with OpenAPI delivery through vanity URLs. If two assets share the same vanity ID, DM with OpenAPI delivers the asset that most recently received that ID, overriding the previous entitlement of the ID to another asset.

      • A single asset can have multiple vanity IDs. Contact Adobe support and raise a request for generating the required vanity IDs.

After setting up your vanity ID in the asset metadata form, map this metadata field to the system’s delivery mechanism.

Create and map Cloud manager environment variable map-cloud-manager-environment-variable

Execute the following steps to create an environment variable and map it to the metadata field holding the vanity ID:

  1. Navigate to the configurations page of your Cloud Manager environment and do the following:

    1. Add ASSET_DELIVERY_VANITY_ID variable. This is the key.
    2. Use the value field to map to the asset metadata property that holds the vanity ID. The mapping follows the dc:<your-metadata-property> format, where the metadata mapping prefix (such as dc:) varies based on your asset metadata configuration property.
      ASSET_DELIVERY_VANITY_ID variable
  2. Save your changes to restart the pods in your environment.

Approve the assets for delivery approve-assets-for-delivery

After mapping the ASSET_DELIVERY_VANITY_ID variable in your Cloud Manager environment to the asset metadata property that holds the vanity ID, approve your assets that require vanity URL for delivery.

Generate Vanity URLs generate-vanity-urls

Make the following replacements in your standard delivery URL to transform it into a vanity URL:

  • Replace UUID with your vanity ID.
  • Replace aaid with avid.

See the URL transformation from standard to vanity URL above.
Learn how to copy Dynamic Media with OpenAPI delivery URLs for your assets.

When your user clicks the vanity URL, Dynamic Media with OpenAPI automatically maps the vanity ID to the original asset UUID at ingestion time and resolves them properly at delivery time to serve the asset to the user without any delay. You can customize the vanity URL in real time without affecting the asset delivery performance.

Use the advanced customization capabilities of AEM Cloud Service with your vanity URL to enhance its impact.

Scale using vanity URLs scale-using-vanity-url

AEM as a Cloud Service enables you to customize the DNS and CDN names within your web addresses. Use these AEMCS capabilities with your vanity URLs to transforms them into unique web-addresses that are clean, descriptive, branded, intuitive and provide the above-mentioned benefits.

See the following vanity URL and its customizable components:

Vanity URL format:

https://delivery-<tenant>.adobeaemcloud.com/adobe/assets/urn:avid:aem:<vanity-id>/as/<seoname>.<format>

https://delivery‑<tenant>.adobeaemcloud.com

Customize this DNS

/

adobe/assets/urn:avid:aem:

Customize URL with rewrite rules

<vanity-id>

Create vanity ID

/as/<seoname>.<format>

Vanity URL format with customized DNS and CDN names:

https://<custom-dns> / dam/assets/ <vanity-id> /as/<seoname>.<format>

Customizable URL Components

Customize DNS customize-dns

Raise a request to Adobe support to generate the required custom DNS for your delivery tier. Follow these best practices for creating custom DNS names.

Rewrite CDN rules rewrite-cdn-rules

Execute the following steps to rewrite the CDN rules for delivery:

  1. Navigate to your AEM repository to create a YAML configuration file.
  2. Execute the steps in setup section to configure CDN rules and deploy the configuration through your Cloud Manager configuration pipeline.
    Follow these best practices for creating your domain path.
    Learn more about CDN rewriting rules.

The following are examples of rewrite rules for appending file names with extensions in vanity URLs. Customize these rewrite rules according to your specific requirements. Contact Adobe support for further assistance:

  when:
    allOf:
      - reqProperty: tier
        equals: delivery

For SVG, GIF, and PDF svg-gif-pdf

    type: transform
      reqProperty: path
      op: replace
      match: ^/dam/assets/([^/]+\.(?:svg|gif|pdf|docx|xlsx))(\?.*)?$
      replacement: /adobe/assets/urn:avid:aem:\1/original/as/\1\2

For video video

For videos including MP4, MOV, AVI and MKV

type: transform
      reqProperty: path
      op: replace
      match: ^/dam/assets/([^/]+\.(?:mp4|mov|avi|mkv))(\?.*)?$
      replacement: /adobe/assets/urn:avid:aem:\1/play\2

For image image

For all image types, excluding SVG.

type: transform
      reqProperty: path
      op: replace
      match: ^/dam/assets/([^/]+\.[^/]+)(\?.*)?$
      replacement: /adobe/assets/urn:avid:aem:\1/as/\1\2

Follow the best practices for creating clean vanity URLs best-practices

Follow these best practices for creating vanity IDs, custom DNS and CDN names:

  1. Do not use special characters in vanity IDs, such as spaces, slashes, hyphens and more. The system replaces special characters in vanity IDs using a predefined mapping.
  2. Use your brand name, product names, and relevant keywords in your vanity IDs, custom DNS and CDN names to boost your brand visibility and user engagement.
  3. Use short, descriptive words or strings that convey meaning.
  4. Use texts that invite users for clicks.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab