Skip to main content

 

Documentation & User Guides | FotoWare

Creating an integration that uses Widgets as well as the FotoWeb API

Learn how to create an integration using Widgets in combination with the FotoWeb API.

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 need to have the API Access group permission set.

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

Application Registration and Authorization

The first step is to build an application as outlined in Authorizing Applications using OAuth, if not already done. During the authorization process, the application obtains an access token, which can be used for API access as well as for embedding widgets, which is shown 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

General use of the widgets is described in the topic 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 in the authorization step is given in the fragment of the URL.

Note: For all widget URLs, pay attention to follow this documentation regarding 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 thus also described in the topic Using the Widgets.

  • Was this article helpful?