Aemdynamicmediaconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 18 actions for the Aemdynamicmediaconnector v1.0.

General (18)

GET Convert image format

/is/image/{companyID}/{imageID}/convert

Convert an image to a different format. Use when you need to change the file format of an existing image asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the image.
`Imageid`	Identifier of the image to convert.
`Format`	Target format for the converted image, such as "jpg" or "png".
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create new folder

/scene7/services/IpsApiService/createFolder

Create a new folder within the Dynamic Media asset hierarchy. Use to organize assets into folders.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	The API method name, typically "createFolder".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Foldername`	Name of the folder to create.
`Parentfolder`	Path of the parent folder where the new folder will be created.

POST Delete media asset

/scene7/services/IpsApiService/deleteAsset

Permanently delete a media asset from Dynamic Media. Use to remove unwanted or outdated assets.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	The API method name, typically "deleteAsset".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Assetid`	Identifier of the asset to delete.

GET Get asset info

/scene7/services/IpsApiService/assetInfo

Retrieve detailed information about a specific media asset. Use to get metadata and properties of an asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	The API method name, typically "assetInfo".
`Assetid`	Identifier of the asset whose information is requested.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get asset metadata

/scene7/services/IpsApiService/metadata

Retrieve metadata fields for a specific media asset. Use to access custom metadata values associated with the asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	The API method name, typically "metadata".
`Assetid`	Identifier of the asset whose metadata is requested.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get dynamic media configurator image

/is/image/{companyID}/{imageID}/config

Retrieve a configurator image with specified layers applied. Use to generate an image with multiple layers for product customization.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the image.
`Imageid`	Identifier of the base image.
`Layer`	Layer definitions to apply to the image, provided as an array of layer parameters.
`Layer0 Opac`	Opacity for layer 0
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get image set

/is/image/{companyID}/{imageSetID}/set

Retrieve an image set composed of multiple images. Use to display a collection of related images as a set.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the image set.
`Imagesetid`	Identifier of the image set to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get media viewer script

/s7viewers/html5/js/{viewerID}.js

Retrieve the JavaScript file for a specific Dynamic Media viewer. Use to embed a viewer on a web page.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Viewerid`	Identifier of the viewer, such as "BasicZoomViewer" or "eCatalogViewer".
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get smart cropped image

/is/image/{companyID}/{imageID}/smartcrop

Retrieve a smart-cropped version of an image. Use to automatically crop an image based on the most important content.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the image.
`Imageid`	Identifier of the image to crop.
`Crop`	Crop dimensions or region definitions, provided as an array.
`Cropmode`	Mode for smart cropping, such as "smart" or "manual".
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get spin set

/is/spin/{companyID}/{spinSetID}

Retrieve a spin set that allows 360-degree rotation of an object. Use to display a product from all angles.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the spin set.
`Spinsetid`	Identifier of the spin set to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get text banner image

/is/image/{companyID}/{imageID}/textbanner

Retrieve an image with overlaid text banner. Use to create a promotional image with custom text.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the image.
`Imageid`	Identifier of the base image.
`Text`	Text content to display on the banner.
`Text Attr`	Text attributes such as font size, color, and alignment.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get transformed image

/is/image/{companyID}/{imageID}

Retrieve a transformed version of an image using Dynamic Media image serving commands. Use to apply modifications like resizing, cropping, or effects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the image.
`Imageid`	Identifier of the image to transform.
`Op Sharpen`	Sharpening option
`Resmode`	Resolution mode
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get video content

/is/content/{companyID}/{videoID}.f4v

Retrieve video content in FLV format. Use to stream or download a Dynamic Media video asset.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the video.
`Videoid`	Identifier of the video asset.
`Response Type`	The response format expected from the API (e.g. application/json).

GET List all assets

/scene7/services/IpsApiService/listAssets

List all media assets in a specified folder. Use to browse or search for assets within a folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	The API method name, typically "listAssets".
`Folder`	Folder path to list assets from.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Publish media assets

/scene7/services/IpsApiService/publish

Publish media assets to make them available on delivery endpoints. Use to push assets from staging to production.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	The API method name, typically "publish".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Assets`	Array of asset identifiers to publish.

GET Resize image

/is/image/{companyID}/{imageID}/resize

Resize the image to specified dimensions. Use this action to generate a version of the image with a custom width and/or height.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the video.
`Imageid`	Identifier of the image to transform.
`Width`	The desired width in pixels for the resized image.
`Height`	The desired height in pixels for the resized image.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Rotate image

/is/image/{companyID}/{imageID}/rotate

Rotate the image by a specified angle. Use this action to change the orientation of the image.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Companyid`	Identifier of the company that owns the video.
`Imageid`	Identifier of the image to transform.
`Angle`	Rotation angle
`Response Type`	The response format expected from the API (e.g. application/json).

POST Upload media file

/scene7/services/IpsApiService

Upload a media file to the Dynamic Media repository. Use this action to add a new asset such as an image or video.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	The API method name, typically "publish".
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file data to upload. Provide the binary content of the media file to be uploaded.