Table of Contents
Dynamic tags for User Interface Integrations
Table of Contents
This topic lists dynamic tags that are supported in User Interface Integrations (UII).
Tag | Description | Examples |
---|---|---|
|
File extension of the asset, not including the dot. |
jpg |
|
File name of the asset, not including the folder path |
|
|
URL of the asset |
The format of the URL is intentionally unspecified. No assumptions should be made about the format of URLs. URLs should not be parsed or generated by third-party applications. The URL can be used by an API client to query the asset representation of the asset. For more information, see The FotoWeb REST API. |
|
Value of a metadata field of the asset. If the metadata field was changed interactively by the user entering a new value in an interactive metadata editor as part of running the action, then this tag returns the latest modified value. If multiple metadata macros are run as part of the action, and they modify the same metadata field, then this tag returns the value of the field after applying all of the previous metadata macros in the order in which they are defined in the action configuration. |
The order of metadata macros matters when determining the final value for the asset metadata field tag. If the following metadata macro is used to set the value of field 120:
then in the next metadata macro, the tag
|
|
OAuth token that can be used by the UII to make requests to the Fotoware API on behalf of the user. |
An access token is only available if the user is logged into FotoWeb. Otherwise, this tag resolves to an empty string. Making API requests directly from JavaScript requires CORS to be enabled for the UII. An alternative way for a UII to obtain an access token is to require the user to log in with OAuth from within the UII (as a regular web integration would do). By using |
Authentication of User Interface Integrations
A UII can obtain an access token by requiring the user to log in with OAuth from within the UII (as a regular web integration would do).
OAuth token notes
Fotoware recommends using the token fragment whenever possible, especially if only the front-end of the integration uses the token.
If, however, the integration has a backend that uses the token, the query string must be used.
An alternative way for a UII to obtain an access token is to require the user to log in with OAuth from within the UII (as a regular web integration would do). By using {{oauth.token}}, this additional login is not necessary. The user only needs to be logged in to FotoWeb.
Specs on UII here:
https://fotoware.atlassian.net/wiki/spaces/FOT/pages/617480240/User+Interface+Integrations#Obtaining-Access-Tokens