Skip to main content
Documentation & User Guides | Fotoware

Creating integrations using embeddable widgets

  1. Last updated
  2. Save as PDF

Overview

FotoWeb provides widgets to export assets to an external system, such as a Content Management System. These widgets are ready-made HTML controls that plug into your web application and enable you to search, retrieve, and export the assets you need.

Available widgets

Two widgets are available for custom integrations: The Selection Widget can be called up from the target system and used to search or browse for an asset, select it, and export it to the target system. This widget can be used on its own orcombined with the Export Widget, which lets users tune the exported asset's appearance and behavior. The Export Widget cannot be used by itself.

iFrames in FotoWeb

Generally, FotoWeb cannot be embedded into iFrames on domains that are not of the same origin. However, the embeddable widgets (Selection Widget and Export Widget) are exempt from this rule. These widgets work in an iFrame because they are designed to be embedded into other applications as part of integrations.

The following rules apply:  

  1. Internal iframes (Fotoweb pages embedding other FotoWeb pages) are allowed.

  2. Same-origin iframes (third-party page on the same host embeds FotoWeb) are allowed.

  3. Cross-origin iframes (third-party page on a different host embeds FotoWeb) are blocked.

  4. Cross-origin iframes embedding the widgets are allowed.

User authorization

Using widgets requires user authorization to access FotoWeb. Furthermore, an integration that uses widgets must be registered as a third-party application in FotoWeb. Read on for instructions.

Note: Integrations with widgets developed against older versions of FotoWeb (before feature release 12 or 8.0.840) will work as before with no changes, provided that the Enable Legacy Widget Integrations option is set in the site settings. See Legacy Widget Integrations for more information.

Choosing your type of integration

Fundamentally, two types of integrations can be made:

  1. Integrations using only the Selection Widget to find and export an asset without additional API functionality
  2. Integrations using a combination of the Selection Widget and the API for a fully customized workflow.

The former is suitable for simple solutions with minimal customization and requiring no additional processing.

The latter allows for a fully custom integration where API calls can be used to update the metadata of the original asset, where image processing can be applied to the exported asset through download processing profiles, and so on. 

Choose the relevant article below based on the integration you're building.