Integration with external image storage

• Last updated on April 4, 2025
• •
• Less than a minute to read

You can integrate the Handy Editor with an external image storage service implemented as a web service.

Configuration

To work with an external image storage service, add the service URL and access token to the integration configuration. Additionally, you must enable this image source in the asset library to display it in the UI.

{
  // ...
  "integration": {
    // ... Other integration settings
    "externalImageStorage": {
      "url": "https://api.external-storage.url",
      "token": "access_token_for_external_storage"
    }
  },
  "settings": {
    "assetLibrary": {
      "externalImageStorage": {
        "enabled": true
      }
    }
  }
}

If the external storage supports file uploads, uploads will use the parameters defined in the settings.imageUploader object.

Updating the Token

To update the token for accessing the external storage, you can call the update() method on the web component with a partial configuration:

handyEditor.update({
  "integration": {
    "externalImageStorage": {
      "token": "new_access_token_for_external_storage"
    }
  }
});

User Interface

Since the external storage may implement various functionalities, you might need to rename the displayed name in the asset library panel.

You can override the displayed name using localization settings with the key assetLibrary.externalStorage.headerLabel. By default, this key has the value Images in the English localization.

{
    localization: {
        language: "en",
        data: {
            "en": {
                "assetLibrary.externalStorage.headerLabel": "Remote Images"
            }
        }
    }
}