Aprimo Asset Integration

Integrate with Aprimo to manage, transform and deliver media assets.

Aprimo integration is only available with our paid plans. However, you can evaluate it in local development mode.

Configuration

After configuring Aprimo to work with your code and content source, you can enable the integration in Stackbit. This differs based on your working mode.

Identify Tenant Name

The value is the collection of characters before the first dot (.) in your Aprimo domain.

For example, if the URL for the Aprimo space is https://partner1.dam.aprimo.com/dam/spaces/..., the tenant would be partner1.

Local Development Configuration

Use the latest version of @stackbit/cli to ensure all Aprimo features are available when working locally.

When working locally, Aprimo is enabled through the --aprimo-tenant option. (See above for identifying your tenant name.)

  • 1
stackbit dev --aprimo-tenant partner1

Cloud Project Configuration

Open the Project Settings dialog (gear icon at the top-left of the visual editor) and switch to the Integrations tab to set up the integration. Add the tenant name and save the settings.

Configure Aprimo in Stackbit
Configure Aprimo in Stackbit

Toggling Asset Sources

When using Aprimo with a headless CMS, the Aprimo image picker will appear when choosing to add or change an image.

Aprimo Image Modal
Aprimo Image Modal

When using Git CMS, the modal provides the option to use other configured options in the bottom left corner of the modal.

Toggle Asset Source
Toggle Asset Source

To specify a field as Aprimo-only, set the source property to aprimo. This will remove the dropdown toggle from the asset modal for that field.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
export default defineStackbitConfig({
  models: [
    {
      name: 'Page',
      fields: [
        { name: 'image', type: 'image', source: 'aprimo' },
        // ...
      ],
      // ...
    },
  ],
  // ...
})

Data Structure

When a user selects an image in the Aprimo widget, the widget returns a JSON object with image metadata. When an integration exists between Aprimo and your content source (via a headless CMS), this data is stored in the format expected by the CMS.

See here for the structure of the selected item.

Git CMS Image Structure

When using Git CMS, the data structure is dependent on the field configuration. By default, Stackbit simply stores a URL string for the selected image.

  • 1
  • 2
  • 3
{
  "image": "https://p1.sb.aprimocdn.net/partner1/..."
}

To store the entire selected object, you must specify the field's source as specific to Aprimo.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
export default defineStackbitConfig({
  models: [
    {
      name: 'Page',
      fields: [
        { name: 'image', type: 'image', source: 'aprimo' },
        // ...
      ],
      // ...
    },
  ],
  // ...
})

Here's an example of a stored object:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
{
  "image": {
    "id": "05d2...",
    "title": "Image title ...",
    "rendition": {
      "id": "bf6b6...",
      "publicuri": "https://p1.sb.aprimocdn.net/partner1/..."
    }
  }
}