Licensing

Integration using the FotoWeb API is available when:

• FotoWeb is installed on-premises with an activated API License
  or
• FotoWeb is a SaaS tenant on a plan that includes API access

Furthermore, users using the integration must have the API Access group permission.

An application that uses widgets as well as the API is like a regular API client that also uses widgets. This means it can be a native application (opening a browser window for the selection widget) or a web application.

Application registration and authorization

The first step is to build an application, as outlined in Authorizing Applications using OAuth, if it hasn't already been done. During the authorization process, the application obtains an access token that can be used for API access and for embedding widgets, as described in the next step.

Older API clients may be using the global API token or user-specific API tokens for API requests. This is still supported. However, in order to embed widgets, an application has to be changed to use OAuth to obtain an access token. It is still possible to use the API key and mix "traditional" API requests with API requests using access tokens, but for simplicity and consistency, we now recommend using access tokens only.

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 fragment.

Note: For all widget URLs, follow this documentation about whether to put the parameters into the query string or fragment.

The export widget URL is the same for both integration types and is also described in Using the Widgets.