Skip to main content

 

Documentation & User Guides | FotoWare

Export API

Programmatic Export using the API

The system can instantly generate an export without any further user interaction. Simply retrieve the asset href from the API or the Selection widget, and then perform the following web request:

​EXPORT /fotoweb/archives/5000-My%20Archive/Path/to/file.jpg.info
Content-Type: application/vnd.fotoware.export-request+json
Accept: application/vnd.fotoware.export-data+json
{
"width": 1234,
"height": 1234,
"publication": "http://example.org",
"preset": "/fotoweb/me/presets/exports/539ff28796aede3348c013b2"
}​

The width (and height) parameters are optional and specify the size of the exported image. At most one one them can be specified, and the other dimension is then calculated by FotoWeb to preserve the aspect ratio of the image.  For example, if the image is 4:3, and the width in the request is set to 400, the height will be 300.
To assign an aspect ratio to  a preset, open the CMS export dialog, draw a crop frame in the size & crop tab and save it as a preset. publication is an arbitrary string that is used for managing exports. It should identify where the export was published. It is recommended to be the URL of the site where the export is published. preset is the URL of the selected preset, which is obtained from the preset lists as described below.

Response

{
    "export": {
        "source": "...",
        "json": "...",
        "image": {
            "normal": "...",
            "highCompression": "...",
            "doubleResolution": "..."
        },
        "widget": "...",
        "size": {
            "w": 921,
            "h": 627
        }
    },
    "caption": {
        "label": "...",
        "tooltip": "..."
    },
    "publication": {
        "text": "..."
    },
    "metadata":{
        "FIELD": "VALUE" | ["VALUE1", "VALUE2", ...],
        ...
    }
}

where

 

Attribute Type Value
export.source URL (Asset)

URL of the exported asset.

Can be used to access the details of the asset using the API or displaying the details in a browser.

export.json URL (object)

JSON representation of the export.

Identical to this JSON representation

export.image URL (JPEG image) Processed and exported asset (normal version)
export.highCompression URL (JPEG image) Processed and exported asset (smaller file size and potentially reduced quality)
export.doubleResolution URL (JPEG image) Processed and exported asset (doubled resolution, for Retina and similar displays)
export.widget URL (HTML)

An HTML widget containing the processed and exported asset with a tooltip and caption and optional additional behavior, if enabled during export

Can be embedded using an IFRAME.

export.size.w Integer Width of the exported image (normal version) in pixels
export.size.h Integer Height of the exported image (normal version) in pixels
caption.label String Caption string, if specified during export
caption.tooltip String Tooltip string, if specified during export
publication.text String Name of publication (free-form string), if specified during export
metadata Dictionary

Metadata of the asset when it was exported.

The keys in this dictionary are the field numbers (as strings).

The values are either strings (for regular fields) or arrays of strings (for bag fields).

  • Was this article helpful?