Breadcrumbs

Frontifyconnector v1

Version 1

Connector Overview: This page documents all 13 actions for the Frontifyconnector v1.

General (13)

GET Crop an asset using focal point

/crop

Crop an asset based on specified width, height, focal point, and zoom

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Width

Width of the cropped image (1-4096)

Height

Height of the cropped image (1-4096)

Fp

Focal point of the image in percentage (x,y) where x and y are floats ranging from 0.0 to 1.0

Crop

Specify focal point cropping

Fp Zoom

Zoom percentage to zoom into the focal point (optional)

Response Type

N/A

POST Delete Asset

/delete_asset

Delete Asset

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

POST Query

/graphql

Query

Parameters

Parameter Name

Description

Content Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A
Options (1)

Option Name

Description

Options

N/A

GET Resize an asset

/resize

Resize and deliver your assets in the best possible size

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Width

Width of the resized image (1-4096)

Height

Height of the resized image (1-4096)

Response Type

N/A

GET Retrieve Asset

/asset_by_id

Retrieve Asset

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve Brands

/brands

Retrieve Brands

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Retrieve Library

/libraries

Retrieve Library

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

GET Set the quality of an image

/image_quality

Set the quality of an image for JPEG and WebP formats

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Quality

Quality percentage of the image (1-100)

Response Type

N/A

GET Show a preview of a specific video frame

/video_frame_preview

Show a preview of a specific video frame by specifying the time in seconds

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Second

Time in seconds to capture the video frame from (0 - X, where X is the duration of the video)

Response Type

N/A

GET Show the correct page of a multipage asset

/page_preview

Show the correct page of a multipage asset (PDF / Office files) by specifying the page number

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Page

Page number to display (1 - X, where X is the total number of pages)

Response Type

N/A

GET Transform the format of an asset

/transform_format

Transform the format of an asset to the specified format

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Format

Desired format of the asset (webp, png, jpeg, jpg, gif, mp4)

Response Type

N/A

POST Update Asset

/update_asset

Update Asset

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A

PUT Update Asset Custom Metadata

/update_custom_metadata

Update Asset Custom Metadata

Parameters

Parameter Name

Description

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Response Type

N/A