Knowledge Base

Drupal 8 and 9 Integration

When you integrate Drupal 8 with Bynder you can add image and document assets from Bynder to your Drupal 8 or 9 content using our Compact View. The integration ensures that the latest version of your Bynder assets is automatically reflected in your Drupal content. Find out below how you can start making use of this integration.

Before You Begin

  • Make sure you have a Bynder account. Visit https://www.bynder.com/ for more information.

  • Bynder uses OAuth to allow external applications to connect to it. Drupal will use this to integrate with Bynder. You need to generate API credentials before proceeding. If you want to generate your credentials see Create API tokens for your app.

Supported Versions

The available plugins support Drupal 8 or both 8 and 9. If you are upgrading from Drupal 7, uninstall the Drupal 7 plugin, and install the one for Drupal 8 or 9.

Available Integrations

4.x

This is the preferred Drupal integration, which supports both Drupal 8 and 9. You can find the requirements and main features below:

Requirements

  • Only supports OAuth 2.0

  • Requires Entity Usage 2.x

Features

  • Supports Drupal 8 and 9

  • Makes use of the Compact View

  • Add images, videos and documents to your Drupal content

  • Map an asset type to a specific media type in Drupal

  • SNS Notifications

8.x-2.x

This Drupal integration supports Drupal 8 and 9 and is based on the Drupal core media module.

8.x-1.x

This Drupal integration is using the core Media module and supports Drupal 8. There's only minimum support for this integration.

If you have an existing site with Media Entity 1.x and you want to upgrade to Media in core, you need to update the code of this module from 1.x to 2.x or later. Please check the upgrade instructions on the project's documentation page for more information on that process.

Comparison Table

Features

4.x

8.x-2.x

8.x-1.x

Drupal 8 Compatible

Drupal 9 Compatible

OAuth 2.0

Compact View

SNS Notifications

Asset Tracker

Add Images to Drupal Content

Add Videos to Drupal Content

Add Documents to Drupal Content

Support Available for Integration

Derivatives Used

There are three basic derivative sizes created initially (webimage, mini and thul (thumbnail)). If you need more derivatives created, contact your Customer Success Manager. Since derivatives are generated on upload and are configured prior to the bulk media import, Bynder recommends creating Drupal-specific derivatives at the start of your implementation. If not, then you might encounter additional Professional Services fees for generating additional derivatives.

Read more about derivatives here.

How to Download, Install and Configure the Drupal Integration?

Check the download, installation and configuration instructions for our available Drupal integrations below.

4.x
  1. Click here to visit the download page of the 4.x Drupal integration.

  2. Click here for installation and configuration instructions.

8.x-2.x

Click here for download, installation and configuration instructions for the 8.x-2.x Drupal integration.

8.x-1.x

Click here for download, installation and configuration instructions for the 8.x-2.x Drupal integration.

Use the Plugin

Attach Bynder Media to Content
  1. To attach a Bynder asset to your content, open the content page and click Select assets in the Media Assets section.

  2. The Compact View will open. If your company's Bynder portal URL is already filled in in the pop-up, click Connect. If not, enter the URL in the below format. A popup will open, which allows you to login to your Bynder environment.

    https://YourPortalURL.com
  3. Log in to the portal the usual way.

  4. In the Asset tab use the filter bar or search bar filter and search for the assets you need. Select the files(s) you need and click Add asset(s) to add the asset(s) to your Drupal content. In the Collection tab select the collection that you want to add or click the collection and select the file(s) you want to add. Click Add asset(s) to add the asset(s) to your Drupal content.

  5. Click Save to save the changes.

Note

The default time to live (TTL) is one day if you use Bynder CDN. However, if you use CDN of another provider, the TTL may be different since it depends on the CDN configuration.

Upload Assets to Bynder

Bynder uploader widget allows uploading assets from a Drupal site to Bynder. You can upload more than one file at a time. If the description text is provided it will be used for all assets that are uploaded in a given step. You need to log in before you can start uploading.

Note

Depending on the setup of the integration the possibility to upload assets to Bynder may not be available.

  1. To upload an asset to Bynder, go to a content page and click Select assets in the Media Assets section.

  2. The Compact View will open. If your company's Bynder portal URL is already filled in in the pop-up, click Connect. If not, enter the URL in the below format. A popup will open, which allows you to login to your Bynder environment.

    https://YourPortalURL.com
  3. Log in to the portal the usual way.

  4. Open the Upload tab, which you can find at the top of the Compact View.

    upload_drupal.png
  5. In the File upload section click the Select files button.

  6. Select the files you want to upload from your device and click the Upload assets button.

Depending on your Bynder permissions, the assets you upload from Drupal can go to the Waiting Room or directly to the Asset Bank. You also need to be able to upload media to Bynder in your Bynder permission profile to upload files from Drupal.

Note

Even if you do not have the permissions to upload files to Bynder, you will still see the upload tab in Drupal. However, the assets will not be uploaded to Bynder if you try to upload.

After you have uploaded the asset, you can search for it on the description you provided. However, currently the files do not display any indication that they have been uploaded from Drupal.

Note

Currently we do not ingest the metadata embedded in the Drupal asset when you upload this asset to Bynder.

Edit Bynder Assets in Drupal
  1. Go to Content and open the Media tab.

    edit-media.png
  2. Select the asset you want to edit.

  3. Click Edit.

  4. Introduce your changes and click the Save button.

    edit-drupal.png

    Note

    All edits of the metadata on the Drupal side are considered overrides and won’t be synced back to Bynder. In order to make changes permanent they need to be edited in Bynder. Click the edit asset's metadata on Bynder link to open the asset directly in Bynder.

Remove Bynder Assets from Drupal
  1. Go to Content and open the Media tab.

  2. Select the asset(s) you want to remove.

  3. Open the Action dropdown and click Delete media.

  4. Click the Apply to selected items button.

  5. Read the warning message carefully and click Delete to permanently remove the asset in Drupal.

SNS Notifications

If you use a custom CDN or you want to copy the assets to Drupal's own library you can automatically update your assets by using SNS notifications. The moment a new version of the asset is uploaded to your Bynder portal the changes will be automatically reflected in Drupal. SNS notifications are supported in the Drupal 4.x integration.

Read more about Bynder SNS notifications here and read more about setting up SNS notifications in your Drupal 4.x integration here.

Limitations

  • When you use the default AWS CDN of Bynder your assets will be automatically updated in Drupal if they're updated in Bynder. The metadata will not be updated, though.

Learn more