Table of Contents
Creating an integration that uses widgets only
Learn how to create a basic integration that exports an asset using FotoWeb widgets.
Table of Contents
This topic explains how to create an integration using the FotoWeb Selection Widget and Export Widget without using features that require additional API access.
Licensing
Integration using only widgets is available in:
- Fotoware Veloz for all users with an Editor license
- Fotoware Veloz for tenants on a subscription plan, which includes API access
- FotoWeb On-premises for all users with a Main or Pro license
- FotoWeb On-premises with an activated API license
Application registration
- In the FotoWeb Settings app, open Sites.
- Select Configuration for the site in question.
- Go to Integrations > Applications.
- Select Add application.
- From the Type dropdown list, select Native/mobile if you're developing an integration without a back end, or Web App/API if you have a back end.
- Select the Selection Widget option.
- As the redirection URI, specify the web URL where the application is hosted.
- Make a copy of the client ID, which will be needed in the application.
Authorization - without back end
Once the user visits the application's start page in the browser, the application must request an access token, which it must pass to embedded widgets to authorize the user to access FotoWeb.
The process of authorizing an app without a back end is documented in Authorizing applications using OAuth - Single-Page JavaScript Web Apps without back-end.
Authorization - with back-end
Integration with a back end requires additional development in a different language and a suitable hosting platform (such as a stand-alone server or an app service in Microsoft Azure). A database or another kind of persistent storage is also needed to store tokens. Such infrastructure incurs additional operational costs but may be acceptable due to the benefits, or it may already be available, for example, if the integrator already has a server, app service, and database used for other purposes.
An app with a back-end provides additional security and a better user experience. Users can stay logged in without having to re-authenticate (using refresh tokens), and the app's authenticity is further verified using a client secret.
Authorization with a back end is documented in Web Application or API authorization.
A note about authorization
Both types of authorization are reasonably secure as long as the app is hosted over HTTPS, which ensures app authentication and the consent dialog.
Widget integration
For information about the general use of the widgets, see Using the widgets.
The URL of the selection widget is as follows:
https://acme.fotoware.cloud/fotoweb/widgets/selection?access_token=ACCESS_TOKEN
where ACCESS_TOKEN is replaced by the access token obtained during the authorization step specified in the URL query string.
Note
For all widget URLs, follow this documentation for whether to put the parameters into the query string or fragment.
The URL of the export widget is the same for both types of integration and is also described in Using the widgets.