Asset Bank

This integration allows business users to build personalized digital experiences (web sites, web apps, mobile apps, etc.) by repurposing content from your Asset Bank digital asset management system. It also enables developers to use their preferred front-end tools to build these applications.

Requirements#

• An enterprise subscription with Asset Bank is required to use this integration.
• The Asset Transformer Module has to be enabled for your account to correctly work with Uniform. This is an enterprise-level module that allows optimized web delivery and asset transformation. To have it enabled please contact your Asset Bank account manager or sales representative.

Known limitations#

• Image files only: Only image files are supported due to the Asset Transformer Module limitations.
• Format restrictions: Some image transformation features may be limited to specific image formats due to the Asset Transformer Module limitations.
• Assets must have the Asset Transformer enabled to be used in Uniform.

Installation and configuration#

Set up Asset Bank OAuth application#

In your Asset Bank account you need to create a new OAuth application that will be used to authenticate with the Asset Bank API in Uniform.

1. Log into your Asset Bank account.
2. Navigate to Settings > API.
3. Click Add OAuth application.
   

   Asset Bank OAuth applications
4. Enter the following values:

   • Name of the OAuth application (e.g. Uniform integration)

   • Description of the OAuth application

   • Client Id (this will be generated automatically)

   • Secret (this will be generated automatically)

   • Redirect URLs: This consists of the URL of your hosted Uniform integration (e.g. https://your-asset-bank-integration.app) and the call back route /api/auth/callback/assetbank.app.

     So in this example the full redirect URL is: https://your-asset-bank-integration.app/api/auth/callback/assetbank.app

     

     Asset Bank OAuth applications

     Getting the URL of your hosted Uniform integration

     In some cases, you will only know the URL of your hosted Uniform integration after deployment. However, deployment requires you to set the OAuth application ID and secret as environment variables in your Uniform integration instance. When creating the OAuth application, you can enter a valid placeholder for the URL and update it with the correct value later.

Deploy the Uniform integration#

1. Clone the Asset Bank integration repository:

2. Follow the instructions in the README to deploy the Uniform integration to your hosting provider.

We recommend using Vercel to host your integration. However, you can choose any hosting provider that supports Next.js API routes, as these are required for authenticating with the Asset Bank API.

Register Asset Bank as a custom integration#

1. Go to Uniform dashboard
2. Navigate to your Team dashboard > Settings > Custom Integrations
3. Click Add Integration and copy-paste manifest from mesh-manifest.stable.json Replace http://localhost:4064 in the manifest with the URL of your previously deployed integration
4. Click Save

Install the Asset Bank integration#

Make assets housed in Asset Bank available to the Uniform asset library by adding this integration to your Uniform project.

1. In Uniform, open your project.

2. Navigate to Settings > Integrations.

3. Scroll to the section Browse Integrations.

4. Click Asset Bank (your custom integration).

5. Click Add to project.

6. Enter the required values:

   Uniform setting	Value
   Account URL	Asset Bank dashboard URL , e.g. https://company.assetbank.app/assetbank-company
   Asset Transformer URL	Base URL of Asset Transformer module , e.g. https://d54otazn342w10.cloudfront.net/externalApps/435fe330-287c-46bc-9b96-bbf41bdc55c5
   Allowed transformation identifiers	List the preset transformation identifiers from your Asset Transformer that are allowed in Uniform. These identifiers are managed in the "Asset Transformer" section of your Asset Bank account. Asset Bank's Asset Transformer settings

   Getting Asset Transformer URL

   To get the Asset Transformer URL, open an asset in Asset Bank and click on "Edit crops" which opens a modal. For each crop, the URL is displayed in the "URL" field. Grab the first part of the URL (before the /conversion/ part).

   

   Access Asset Bank's crop details

   If you have trouble finding the Asset Transformer URL, please contact your Asset Bank account manager.

7. Login with your Asset Bank account

8. Sync metadata

9. Optional: Set allowed filters for Asset Bank attributes to be used in Uniform.

10. Optional: Set additional metadata from Asset Bank attributes to be included in the front-end payload.

11. Click Save.

Asset Bank settings

After you install the Asset Bank integration, new asset library becomes available.

Use Asset Bank in the asset library#

You can access and browse your Asset Bank assets directly within Uniform's asset library. You can also search and filter assets using the Asset Bank attributes you set up in the integration settings.

Asset Bank asset library

Use Asset Bank assets in Uniform's visual editor#

You can insert assets from Asset Bank directly into your Uniform components and entries using the asset parameter.

Asset Bank assets used in an asset parameter