Overview

The SmartFrame Cloud can connect to your image repository and pull source image files as they are needed. To do this, all it needs is access details to the location of your image files.

On-demand option

By default, the SmartFrame Cloud will pull selected images on demand, as they are being viewed, as opposed to processing all of your images. It’s an efficient integration method, and is particularly suitable for integrations where only certain images need to be processed.

The repository of images in the SmartFrame Cloud is being dynamically created as the web pages are being viewed, which prevents the bottleneck of bulk uploading and eliminates unnecessary processing of images that are never viewed.

The on-demand configuration is enabled at default, but it’s also possible to process and cache the entire image collection.

User experience

The first time the image is viewed, it has to be downloaded from your image repository to the SmartFrame Cloud, and processed into the SmartFrame format. There will be a small delay as this happens, although this only applies to the first time the image is viewed.

The viewer of the SmatFrame will first see a loader, followed by a low-resolution placeholder image. Once the image is fully processed into the resolution appropriate for the given display, it will be displayed crisp and clear.

The Hyper Zoom feature will be disabled during the first visit, but will be available a few seconds later, once the zoom assets are processed and cached.

Hook API

Hook API allows to trigger the SmartFrame Image Source Connector so it uploads a new image or update an existing one.

Upload a new image

GET https://api2.smartframe.io/v1/eis/create/[IMAGE_ID] with required header x-api-key=[API_KEY]
will add an image with given IMAGE_ID to the processing queue.

Inline curl example:

curl -X GET \
https://api2.smartframe.io/v1/eis/create/[IMAGE_ID] \
-H 'x-api-key: [API_KEY]' \
-H 'accept: application/json'

Example response success:

{"status":"success","message":"image will be created in a while"}

Example response with error:

{"error":"image with id IMAGE_ID already exist"}

Updating an existing image

GET https://api2.smartframe.io/v1/eis/update/[IMAGE_ID] with required header x-api-key=[API_KEY]
In case the updated image is up to 3MB or 5000x5000px, processing will start immediately (on demand, during GET request). Otherways will be added to the queue.

Inline curl example:

curl -X GET \
https://api2.smartframe.io/v1/eis/update/[IMAGE_ID] \
-H 'x-api-key: [API_KEY]' \
-H 'accept: application/json'

Example response success:

{"status":"success","message":"image updated on demand"}

Example response with error:

{"error":"image with id IMAGE_ID does not exist"}

API_KEY is available in the SmartFrame Panel by going to Account > Integration menu.

Technical requirements

SmartFrame requires access to your image repository. The most common examples are REST API, HTTP(s), FTP and Amazon S3, but it can accommodate any type of repository on request.

SmartFrame requires an [image_id] in the <smart-frame> tag which is the unique identifier of the image.

To find out more about this type of integration, speak to our integrations team.