Skip to content

uniformdev/uniform-mesh-asset-bank

Repository files navigation

Uniform Asset Bank

Asset Bank integration for Uniform DXP

Features

  • Overview image assets from your Asset Bank account
  • Use image assets for Uniform Assets parameter

Installation

Prerequisites

Create Asset Bank OAuth app

  1. Go to Asset Bank Dashboard => System => API
  2. Click Add new OAuth2 credentials
  3. Update Name and Secret
  4. Update Redirect URLs: <VERCEL_SITE_URL>/api/auth/callback/assetbank.app (e.g https://uniform-mesh-asset-bank.vercel.app/api/auth/callback/assetbank.app)
  5. Click Save

Deploy Mesh Integration

Deploy with Vercel

Asset Bank integration requires a few environment variables:

  • ASSET_BANK_ACCOUNT_URL - your Asset Bank account URL (e.g. https://company.assetbank.app/assetbank-company)
  • NEXTAUTH_URL (optional) - your Vercel site URL (e.g. https://asset-bank.vercel.app)
  • NEXTAUTH_SECRET - secret key for NextAuth to sign and encrypt JWT tokens and cookies
  • AUTH_APP_ID - OAuth application ID for Asset Bank authentication
  • AUTH_APP_SECRET - OAuth application secret for Asset Bank authentication

Manual deployment

  1. Fork this repository (optional)
  2. Create Vercel project based on the repository
  3. Configure Vercel environment variables (see the list above)

Register Mesh Integration

  1. Go to Uniform dashboard => Your team => Settings => Custom Integrations
  2. Click Add Integration and copy-paste manifest from mesh-manifest.stable.json
  3. Replace http://localhost:4064 in the manifest with previously deployed Vercel's site URL
  4. Click Save

Local development

To run the integration locally:

  1. Install dependencies: npm install
  2. Copy .env.example to .env and define required environment variables
  3. Start the development server: npm run dev
  4. Register a custom integration for your team using manifest from mesh-manifest.local.json
  5. Register a separate Asset Bank OAuth app, use http://localhost:4064/api/auth/callback/assetbank.app for Redirect URLs

About

Asset Bank integration for Uniform DXP

Resources

Stars

Watchers

Forks

Releases

No releases published