Asset Processor API

This API is used to work with the assets stored in the storage - get metadata, previews, etc.

While the Asset Storage API is used to make the CRUD operations on the assets, it does not allow doing anything useful with them. This is where the Asset Processor comes to help.

Using the processor, you can perform operations which require some knowledge about the content of an asset. Here are some examples of these tasks:

• Extracting metadata - e.g. get width/height for an image or a postscript name for a font.
• Generating a preview image
• Importing an asset to a storage

Interactive API Docs

Api Clients

.Net Client

You can install it from Nuget as follows:

Install-Package Aurigma.AssetProcessor.ApiClient

See on Nuget

Angular Client

This client is compatible with Angular applications only. It won't work with NodeJS or other frontend JS frameworks. You can install the package to your Angular application as follows:

npm install @aurigma/ng-asset-processor-client

See on npm

NodeJS Client (Axious)

This client can be used in a wide range of JavaScript applications. To make API calls, it uses Axios - a popular HTTP library. Although it is possible to use it in both frontend and backend projects, the primary target platform for this library is NodeJS.

Install the package as follows:

npm install @aurigma/axios-asset-processor-api-client

See on npm

PHP Client

PHP client can be installed through composer as follows:

composer require aurigma/php-asset-processor-client

See on Packagist

BuildInfo

These endpoints can be used to get the technical information about the service such as version, build date and similar. They are also useful for a quick test whether the service is available. All of them are working in the same way and return the same information - use the HEAD or GET flavor of this endpoint based on your preference.

HeadInfo

Get assembly build info.

Request

HEAD /api/processor/v1/info

Responses

Status Code	Type	Description	Samples
200		Success
Headers
X-Aurigma-Version	string	A version number
X-Aurigma-Build-Date	string	A build date (UTC)
X-Aurigma-Configuration	string	A build configuration (Debug | Release)
X-Aurigma-App-Name	string	A service name
X-Aurigma-Design-Atoms-Version	string	An Aurigma.DesignAtoms version number
X-Aurigma-Design-Atoms-Model-Version	string	An Aurigma.DesignAtoms.Model version number

GetInfo

Get assembly build info.

Request

GET /api/processor/v1/info

Responses

Status Code	Type	Description	Samples
200	BuildInfoModel	Success

ColorProfileProcessor

Using these endpoints, you may process color profiles - for example, import it to the storage or update its metadata.

Update

Updates color profile file and metadata in storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/color-profiles/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Color profile entity unique identifier.
tenantId	query			Tenant identifier
name	formData			Color profile name.
path	formData			Color profile location (folder path).
customFields	formData			Color profile custom attributes.
file	formData			Color profile source file.

Responses

Status Code	Type	Description	Samples
200	ColorProfileDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ImportColorProfile

Imports color profile and saves it to storage.

Request

POST /api/processor/v1/color-profiles/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Color profile name.
path	formData			Color profile location (folder path).
customFields	formData			Color profile custom attributes.
*sourceFile	formData			Color profile source file.

Responses

Status Code	Type	Description	Samples
201	ColorProfileDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

DataSchemaProcessor

Using these endpoints, you may process data schemas - for example, import it to the storage or update its metadata.

GetLinks

Gets all links associated with this data schema.

Request

GET /api/processor/v1/data-schemas/{id}/links[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data schema entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DataSchemaLinksInfo	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates data schema file and metadata in storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/data-schemas/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data schema entity unique identifier.
tenantId	query			Tenant identifier
name	formData			Data schema name.
path	formData			Data schema location (folder path).
customFields	formData			Data schema custom attributes.
file	formData			Data schema source file.

Responses

Status Code	Type	Description	Samples
200	DataSchemaDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ImportDataSchema

Imports data schema and saves it to storage.

Request

POST /api/processor/v1/data-schemas/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Data schema name.
path	formData			Data schema location (folder path).
customFields	formData			Data schema custom attributes.
*sourceFile	formData			Data schema source file.

Responses

Status Code	Type	Description	Samples
201	DataSchemaDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

DataSetProcessor

Using these endpoints, you may process data sets - for example, import it to the storage or update its metadata.

Check

Checks if data set taken from storage has any problems.

Request

POST /api/processor/v1/data-sets/{id}/check[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DataSetProblemInfo	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExportDataSet

Exports data set

Request

GET /api/processor/v1/data-sets/{id}/export[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

EmbedDataSchema

Embeds linked data schema to the data set.

Request

POST /api/processor/v1/data-sets/{id}/schema/embed[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DataSetDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExtractDataSchema

Extracts data schema from data set and saves it to the specified folder.

Request

POST /api/processor/v1/data-sets/{id}/schema/extract[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier.
tenantId	query			Tenant identifier
body	body	DataSetExtractDataSchemaModel		Extract data schema operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LinkDataSchema

Links data schema to the data set.

Request

POST /api/processor/v1/data-sets/{id}/schema/link[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier.
tenantId	query			Tenant identifier
body	body	DataSetLinkDataSchemaModel		Link schema operation parameters.

Responses

Status Code	Type	Description	Samples
200	DataSetDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates data set file and metadata in storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/data-sets/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Data set entity unique identifier.
tenantId	query			Tenant identifier
name	formData			Data set name.
path	formData			Data set location (folder path).
customFields	formData			Data set custom attributes.
file	formData			Data set source file.

Responses

Status Code	Type	Description	Samples
200	DataSetDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ImportDataSet

Imports data set and saves it to storage.

Request

POST /api/processor/v1/data-sets/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Data set name.
path	formData			Data set location (folder path).
customFields	formData			Data set custom attributes.
*sourceFile	formData			Data set source file.

Responses

Status Code	Type	Description	Samples
201	DataSetDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

DesignProcessor

Using these endpoints, you may process designs(used as templates) - for example, import it to the storage, generate a preview or update its metadata.

CalculateCountPerSheet

Calculates the design count per sheet of the specified size.

Request

POST /api/processor/v1/designs/{id}/calculate-count-per-sheet[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
body	body	DesignCountPerSheetCalculationModel		Model to calculate the design count per sheet of the specified size.

Responses

Status Code	Type	Description	Samples
200	DesignCountPerSheetCalculationResultDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Check

Checks if design taken from storage has any problems.

Request

POST /api/processor/v1/designs/{id}/check[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignProblemInfo	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDepositPhotos

Returns information about inserted images from DepositPhotos.

Request

POST /api/processor/v1/designs/{id}/depositphotos[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	ImageDepositPhoto []	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExportDesign

Exports design file.

Request

GET /api/processor/v1/designs/{id}/export[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreview

Creates preview image for design taken from storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/designs/{id}/preview/{namespace}/{name}/{width}x{height}[?surfaceIndex&stub&format&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source design entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
surfaceIndex	query			Design surface index Indicates which design surface should be used as a source for preview
stub	query			Design Preview stub contnent switcher Indicates whether to show stub content in preview
format	query			Design preview image format
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreviewUrl

Creates preview image for design taken from storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/designs/{id}/preview/{namespace}/{name}/{width}x{height}/url[?surfaceIndex&stub&format&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source design entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
surfaceIndex	query			Design surface index Indicates which design surface should be used as a source for preview
stub	query			Design Preview stub contnent switcher Indicates whether to show stub content in preview
format	query			Design preview image format
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ReimportDesign

Re-imports design from source file and updates design file and metadata in storage.

Design source file should be a state file or a graphic file.
The marker shortcuts file used only for graphic sources that support markers (PSD or IDML).

Request

POST /api/processor/v1/designs/{id}/re-import[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
*sourceFile	formData			Design source file.
markerShortcutsFile	formData			Marker shortcuts config file.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
409	DesignImportConflictDto	Conflict
401		Unauthorized
403		Forbidden

EmbedDataSchema

Embeds linked data schema to the design file.

Request

POST /api/processor/v1/designs/{id}/schema/embed[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExtractDataSchema

Extracts data schema from design file and saves it to the specified folder.

Request

POST /api/processor/v1/designs/{id}/schema/extract[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
body	body	DesignExtractDataSchemaModel		Extract data schema operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LinkDataSchema

Links data schema to the design file.

Request

POST /api/processor/v1/designs/{id}/schema/link[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
body	body	DesignLinkDataSchemaModel		Link schema operation parameters.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RemoveDataSchema

Removes data schema from the design file.

Request

POST /api/processor/v1/designs/{id}/schema/remove[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

EmbedToggleSet

Embeds linked toggle set to the design file.

Request

POST /api/processor/v1/designs/{id}/toggle-set/embed[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExtractToggleSet

Extracts toggle set from design file and saves it to the specified folder.

Request

POST /api/processor/v1/designs/{id}/toggle-set/extract[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
body	body	DesignExtractToggleSetModel		Extract toggle set operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LinkToggleSet

Links toggle set to the design file.

Request

POST /api/processor/v1/designs/{id}/toggle-set/link[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
body	body	DesignLinkToggleSetModel		Link toggle set operation parameters.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RemoveToggleSet

Removes toggle set from the design file.

Request

POST /api/processor/v1/designs/{id}/toggle-set/remove[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates design file and metadata in storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/designs/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
designParams.name	formData			Design name.
designParams.path	formData			Design location (folder path).
designParams.customFields	formData			Design custom attributes.
file	formData			Design source file.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
409	DesignUpdateConflictDto	Conflict
401		Unauthorized
403		Forbidden

CreateBlankDesign

Creates design using basic settings and saves it to storage.

Request

POST /api/processor/v1/designs/blank[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	CreateBlankDesignModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

CreateDesignFromMockup

Creates design compatible to specified mockup and saves it to storage.

Request

POST /api/processor/v1/designs/from-mockup[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	CreateDesignFromMockupModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

ImportDesign

Imports design from source file and saves it to storage.

Design source file should be a state file or a graphic file.
The marker shortcuts file used only for graphic sources that support markers (PSD or IDML).
Additionally makes design preview if requested.

Request

POST /api/processor/v1/designs/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
designParams.name	formData			Design name.
designParams.path	formData			Design location (folder path).
designParams.customFields	formData			Design custom attributes.
previewSettings.makePreview	formData			Force make preview.
previewSettings.namespace	formData			Preview namespace.
previewSettings.name	formData			Preview name.
previewSettings.width	formData			Preview image width.
previewSettings.height	formData			Preview image heigth.
previewSettings.stub	formData			Preview stub contnent switcher. Indicates whether to show stub content in preview.
previewSettings.format	formData			Preview image format.
*sourceFile	formData			Design source file.
markerShortcutsFile	formData			Marker shortcuts config file.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	DesignImportConflictDto	Conflict
401		Unauthorized
403		Forbidden

ValidateDesignImportSettings

Validates the design import settings.

Request

POST /api/processor/v1/designs/validate-import-settings[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
markerShortcutsFile	formData			Marker shortcuts config file.

Responses

Status Code	Type	Description	Samples
200	ValidationResultDto	Success
401		Unauthorized
403		Forbidden

DocumentProcessor

Using these endpoints, you may process various documents (configs, templates, etc) for example, import it to the storage or update its metadata.

Update

Updates the document file and metadata in the storage.

If the document file is not provided, the metadata will be updated using the file from the repository.

Request

POST /api/processor/v1/documents/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Document entity ID.
tenantId	query			Tenant identifier
name	formData			Document name.
path	formData			Document location (folder path).
customFields	formData			Document custom attributes.
file	formData			Document source file.
type	formData			Document type.
format	formData			Document format.

Responses

Status Code	Type	Description	Samples
200	DocumentDto	Success
404	ProblemDetails	Not Found
409	ImportDocumentConflictDto	Conflict
401		Unauthorized
403		Forbidden

CreateBlankToggleSet

Creates a new blank toggle set and saves it to the storage.

Request

POST /api/processor/v1/documents/blank-toggle-set[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	CreateBlankToggleSetModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
201	DocumentDto	Success
409	ImportDocumentConflictDto	Conflict
401		Unauthorized
403		Forbidden

ImportDocument

Imports a document from the source file and saves it to the storage.

Request

POST /api/processor/v1/documents/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Document name.
path	formData			Document location (folder path).
customFields	formData			Document custom attributes.
*sourceFile	formData			Document source file.
type	formData			Document type.
format	formData			Document format.

Responses

Status Code	Type	Description	Samples
201	DocumentDto	Success
409	ImportDocumentConflictDto	Conflict
401		Unauthorized
403		Forbidden

FontProcessor

Using these endpoints, you may process fonts - for example, import it to the storage, generate a preview or update its metadata.

PreparePreview

Creates preview image for font taken from storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/fonts/{id}/preview/{namespace}/{name}/{width}x{height}[?text&format&maxWidth&fontSize&horizontalAlignment&verticalAlignment&background&textColor&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source font entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
text	query			Text, that will be visualized with selected font in preview image, e.g. 'Abg'
format	query			Preview image format
maxWidth	query			Max width of preview image If parameter is set then normal widht and height and font size are ignored
fontSize	query			Max width of preview image If parameter is set then normal widht and height and font size are ignored
horizontalAlignment	query			Horizontal alignment of text visualization in preview image
verticalAlignment	query			Vertical alignment of text visualization in preview image
background	query			Background color for preview image
textColor	query			Text color for preview image
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreviewUrl

Creates preview image for font taken from storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/fonts/{id}/preview/{namespace}/{name}/{width}x{height}/url[?text&format&maxWidth&fontSize&horizontalAlignment&verticalAlignment&background&textColor&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source font entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
text	query			Text, that will be visualized with selected font in preview image, e.g. 'Abg'
format	query			Preview image format
maxWidth	query			Max width of preview image If parameter is set then normal widht and height and font size are ignored
fontSize	query			Max width of preview image If parameter is set then normal widht and height and font size are ignored
horizontalAlignment	query			Horizontal alignment of text visualization in preview image
verticalAlignment	query			Vertical alignment of text visualization in preview image
background	query			Background color for preview image
textColor	query			Text color for preview image
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates font file and metadata in storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/fonts/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Font entity unique identifier.
tenantId	query			Tenant identifier
name	formData			Font name.
path	formData			Font location (folder path).
customFields	formData			Font custom attributes.
file	formData			Font source file.

Responses

Status Code	Type	Description	Samples
200	FontDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ImportFont

Imports font from source file and saves it to storage.

Additionally makes font preview if requested.

Request

POST /api/processor/v1/fonts/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Font name.
path	formData			Font location (folder path).
customFields	formData			Font custom attributes.
previewSettings.makePreview	formData			Force make preview.
previewSettings.namespace	formData			Preview namespace.
previewSettings.name	formData			Preview name.
previewSettings.width	formData			Preview image width.
previewSettings.height	formData			Preview image heigth.
previewSettings.text	formData			Text, that will be visualized with selected font in preview image, e.g. 'Abg'.
previewSettings.format	formData			Preview image format.
previewSettings.maxWidth	formData			Max width of preview image If parameter is set then normal widht and height and font size are ignored.
previewSettings.fontSize	formData			Font size for text visualization in preview image.
previewSettings.horizontalAlignment	formData			Horizontal alignment of text visualization in preview image.
previewSettings.verticalAlignment	formData			Vertical alignment of text visualization in preview image.
previewSettings.background	formData			Background color for preview image.
previewSettings.textColor	formData			Text color for preview image.
*sourceFile	formData			Font source file.

Responses

Status Code	Type	Description	Samples
201	FontDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

ImageProcessor

Using these endpoints, you may process public images(clipart, backgrounds, etc) - for example, import it to the storage, generate a preview or update its metadata.

PreparePreview

Creates preview image for image taken from storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/images/{id}/preview/{namespace}/{name}/{width}x{height}[?jpegQuality&fitMode&interpolationMode&background&applyAutoCrop&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source image entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
jpegQuality	query			Quality of Jpeg previews
fitMode	query			Image preview fit mode
interpolationMode	query			Image preview interpolation mode
background	query			Background color for transparent images
applyAutoCrop	query			Indicates if the image should be automatically cropped.
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreviewUrl

Creates preview image for image taken from storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/images/{id}/preview/{namespace}/{name}/{width}x{height}/url[?jpegQuality&fitMode&interpolationMode&background&applyAutoCrop&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source image entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
jpegQuality	query			Quality of Jpeg previews
fitMode	query			Image preview fit mode
interpolationMode	query			Image preview interpolation mode
background	query			Background color for transparent images
applyAutoCrop	query			Indicates if the image should be automatically cropped.
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates image file and metadata in storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/images/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Image entity unique identifier.
tenantId	query			Tenant identifier
name	formData			Image name.
path	formData			Image location (folder path).
customFields	formData			Image custom attributes.
file	formData			Image source file.

Responses

Status Code	Type	Description	Samples
200	ImageDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ImportImage

Imports image from source file and saves it to storage.

Additionally makes image preview if requested.

Request

POST /api/processor/v1/images/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Image name.
path	formData			Image location (folder path).
customFields	formData			Image custom attributes.
previewSettings.makePreview	formData			Force make preview.
previewSettings.namespace	formData			Preview namespace.
previewSettings.name	formData			Preview name.
previewSettings.width	formData			Preview image width.
previewSettings.height	formData			Preview image heigth.
previewSettings.jpegQuality	formData			Quality of Jpeg previews.
previewSettings.fitMode	formData			Image preview fit mode.
previewSettings.interpolationMode	formData			Image preview interpolation mode.
previewSettings.background	formData			Background color for transparent images.
*sourceFile	formData			Image source file.

Responses

Status Code	Type	Description	Samples
201	ImageDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

MockupProcessor

Using these endpoints, you may process mockups - for example, import it to the storage, generate a preview or update its metadata.

PreparePreview

Creates a preview for the mockup taken from the storage.

In the case when the preview already exists, returns the existing preview.

Request

GET /api/processor/v1/mockups/{id}/preview/{namespace}/{name}/{width}x{height}[?jpegQuality&fitMode&interpolationMode&background&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source mockup entity ID.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview mockup width.
*height	path			Preview mockup height.
jpegQuality	query			Jpeg preview quality.
fitMode	query			Preview fit mode.
interpolationMode	query			Preview interpolation mode.
background	query			Color to replace transparent background (e.g. 'White').
force	query		False	If set to 'true', a new preview will be prepared, even if the preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreviewUrl

Creates a preview for the mockup taken from the storage.

In the case when the preview already exists, returns the existing preview.

Request

GET /api/processor/v1/mockups/{id}/preview/{namespace}/{name}/{width}x{height}/url[?jpegQuality&fitMode&interpolationMode&background&force&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source mockup entity ID.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview mockup width.
*height	path			Preview mockup height.
jpegQuality	query			Jpeg preview quality.
fitMode	query			Preview fit mode.
interpolationMode	query			Preview interpolation mode.
background	query			Color to replace transparent background (e.g. 'White').
force	query		False	If set to 'true', a new preview will be prepared, even if the preview already existed.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates the mockup file and metadata in the storage.

If the mockup file is not provided, the metadata will be updated using the file from the repository.

Request

POST /api/processor/v1/mockups/{id}/update[?tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Mockup entity ID.
tenantId	query			Tenant identifier
name	formData			Mockup name.
path	formData			Mockup location (folder path).
customFields	formData			Mockup custom attributes.
file	formData			Mockup source file.

Responses

Status Code	Type	Description	Samples
200	MockupDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ImportMockup

Imports a mockup from the source file and saves it to the storage.

Additionally makes the preview of mockup, if required.

Request

POST /api/processor/v1/mockups/import[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
name	formData			Mockup name.
path	formData			Mockup location (folder path).
customFields	formData			Mockup custom attributes.
previewSettings.makePreview	formData			Indicates if a preview is needed.
previewSettings.namespace	formData			Preview namespace.
previewSettings.name	formData			Preview name.
previewSettings.width	formData			Preview width.
previewSettings.height	formData			Preview height.
previewSettings.jpegQuality	formData			Jpeg preview quality.
previewSettings.fitMode	formData			Preview fit mode.
previewSettings.interpolationMode	formData			Preview interpolation mode.
previewSettings.background	formData			Color to replace transparent background (e.g. 'white').
*sourceFile	formData			Mockup source file.
type	formData			Mockup type.

Responses

Status Code	Type	Description	Samples
201	MockupDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

PrivateDesignProcessor

Using these endpoints, you may process private designs (created by the end users) - for example, import it to the storage, generate a preview or update its metadata.

CalculateCountPerSheet

Calculates the private design count per sheet of the specified size.

Request

POST /api/processor/v1/private-designs/{id}/calculate-count-per-sheet[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	DesignCountPerSheetCalculationModel		Model to calculate the design count per sheet of the specified size.

Responses

Status Code	Type	Description	Samples
200	DesignCountPerSheetCalculationResultDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Check

Checks if design taken from private storage has any problems.

Request

POST /api/processor/v1/private-designs/{id}/check[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	DesignProblemInfo	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

GetDepositPhotos

Return information about inserted images from DepositPhotos.

Request

POST /api/processor/v1/private-designs/{id}/depositphotos[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	ImageDepositPhoto []	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExportDesign

Exports design file.

Request

GET /api/processor/v1/private-designs/{id}/export[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreview

Creates preview image for design taken from private storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/private-designs/{id}/preview/{namespace}/{name}/{width}x{height}[?surfaceIndex&stub&format&force&tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source design entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
surfaceIndex	query			Design surface index Indicates which design surface should be used as a source for preview
stub	query			Design Preview stub contnent switcher Indicates whether to show stub content in preview
format	query			Design preview image format
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreviewUrl

Creates preview image for design taken from private storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/private-designs/{id}/preview/{namespace}/{name}/{width}x{height}/url[?surfaceIndex&stub&format&force&tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source design entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
surfaceIndex	query			Design surface index Indicates which design surface should be used as a source for preview
stub	query			Design Preview stub contnent switcher Indicates whether to show stub content in preview
format	query			Design preview image format
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ReimportDesign

Re-imports design from source file and updates design file and metadata in private storage.

Design source file should be a state file or a graphic file.
The marker shortcuts file used only for graphic sources that support markers (PSD or IDML).

Request

POST /api/processor/v1/private-designs/{id}/re-import[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
*sourceFile	formData			Design source file.
markerShortcutsFile	formData			Marker shortcuts config file.

Responses

Status Code	Type	Description	Samples
404	ProblemDetails	Not Found
409	DesignImportConflictDto	Conflict
401		Unauthorized
403		Forbidden

EmbedDataSchema

Embeds linked data schema to the design file.

Request

POST /api/processor/v1/private-designs/{id}/schema/embed[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExtractDataSchema

Extracts data schema from design file and saves it to the specified folder.

Request

POST /api/processor/v1/private-designs/{id}/schema/extract[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	DesignExtractDataSchemaModel		Extract data schema operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LinkDataSchema

Links data schema to the design file.

Request

POST /api/processor/v1/private-designs/{id}/schema/link[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	DesignLinkDataSchemaModel		Link schema operation parameters.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RemoveDataSchema

Removes data schema from the design file.

Request

POST /api/processor/v1/private-designs/{id}/schema/remove[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

EmbedToggleSet

Embeds linked toggle set to the design file.

Request

POST /api/processor/v1/private-designs/{id}/toggle-set/embed[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ExtractToggleSet

Extracts toggle set from design file and saves it to the specified folder.

Request

POST /api/processor/v1/private-designs/{id}/toggle-set/extract[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	DesignExtractToggleSetModel		Extract toggle set operation parameters.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

LinkToggleSet

Links toggle set to the design file.

Request

POST /api/processor/v1/private-designs/{id}/toggle-set/link[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	DesignLinkToggleSetModel		Link toggle set operation parameters.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

RemoveToggleSet

Removes toggle set from the design file.

Request

POST /api/processor/v1/private-designs/{id}/toggle-set/remove[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates design file and metadata in private storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/private-designs/{id}/update[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
designParams.name	formData			Design name.
designParams.path	formData			Design location (folder path).
designParams.customFields	formData			Design custom attributes.
file	formData			Design source file.

Responses

Status Code	Type	Description	Samples
200	DesignDto	Success
404	ProblemDetails	Not Found
409	DesignUpdateConflictDto	Conflict
401		Unauthorized
403		Forbidden

CreateBlankDesign

Creates design by product model and saves it to private storage.

Request

POST /api/processor/v1/private-designs/blank[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	CreateBlankDesignModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

CopyDesignFromPublicDesign

Copies design file from specified public design and saves it to private storage.

Design source file should be a state file.

Request

POST /api/processor/v1/private-designs/from-design[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	CopyDesignFromPublicDesignModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
404	ProblemDetails	Not Found
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

CreateDesignFromMockup

Creates design compatible to specified mockup and saves it to storage.

Request

POST /api/processor/v1/private-designs/from-mockup[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	CreateDesignFromMockupModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

CopyDesignFromPublicResource

Copies design file from specified public resource and saves it to storage.

Design source file should be a state file.

Request

POST /api/processor/v1/private-designs/from-resource[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
body	body	CopyDesignFromPublicResourceModel		Operation parameters.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
404	ProblemDetails	Not Found
422	ProblemDetails	Client Error
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

ImportDesign

Imports design from source file and saves it to private storage.

Design source file should be a state file or a graphic file.
The marker shortcuts file used only for graphic sources that support markers (PSD or IDML).
Additionally makes design preview if requested.

Request

POST /api/processor/v1/private-designs/import[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
designParams.name	formData			Design name.
designParams.path	formData			Design location (folder path).
designParams.customFields	formData			Design custom attributes.
previewSettings.makePreview	formData			Force make preview.
previewSettings.namespace	formData			Preview namespace.
previewSettings.name	formData			Preview name.
previewSettings.width	formData			Preview image width.
previewSettings.height	formData			Preview image heigth.
previewSettings.stub	formData			Preview stub contnent switcher. Indicates whether to show stub content in preview.
previewSettings.format	formData			Preview image format.
*sourceFile	formData			Design source file.
markerShortcutsFile	formData			Marker shortcuts config file.

Responses

Status Code	Type	Description	Samples
201	DesignDto	Success
409	DesignImportConflictDto	Conflict
401		Unauthorized
403		Forbidden

ValidateDesignImportSettings

Validates the design import settings.

Request

POST /api/processor/v1/private-designs/validate-import-settings[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
markerShortcutsFile	formData			Marker shortcuts config file.

Responses

Status Code	Type	Description	Samples
200	ValidationResultDto	Success
401		Unauthorized
403		Forbidden

PrivateImageProcessor

Using these endpoints, you may process private images (user uploads) - for example, import it to the storage, generate a preview or update its metadata.

PreparePreview

Creates preview image for image taken from private storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/private-images/{id}/preview/{namespace}/{name}/{width}x{height}[?jpegQuality&fitMode&interpolationMode&background&applyAutoCrop&force&tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source image entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
jpegQuality	query			Quality of Jpeg previews
fitMode	query			Image preview fit mode
interpolationMode	query			Image preview interpolation mode
background	query			Background color for transparent images
applyAutoCrop	query			Indicates if the image should be automatically cropped.
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreviewUrl

Creates preview image for image taken from private storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/private-images/{id}/preview/{namespace}/{name}/{width}x{height}/url[?jpegQuality&fitMode&interpolationMode&background&applyAutoCrop&force&tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source image entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
jpegQuality	query			Quality of Jpeg previews
fitMode	query			Image preview fit mode
interpolationMode	query			Image preview interpolation mode
background	query			Background color for transparent images
applyAutoCrop	query			Indicates if the image should be automatically cropped.
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates image file and metadata in private storage.

If file is not provided metadata will be updated using file taken from storage.

Request

POST /api/processor/v1/private-images/{id}/update[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Image entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
name	formData			Image name.
path	formData			Image location (folder path).
customFields	formData			Image custom attributes.
file	formData			Image source file.

Responses

Status Code	Type	Description	Samples
200	ImageDto	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

ImportImage

Imports image from source file and saves it to private storage.

Additionally makes image preview if requested.

Request

POST /api/processor/v1/private-images/import[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
name	formData			Image name.
path	formData			Image location (folder path).
customFields	formData			Image custom attributes.
previewSettings.makePreview	formData			Force make preview.
previewSettings.namespace	formData			Preview namespace.
previewSettings.name	formData			Preview name.
previewSettings.width	formData			Preview image width.
previewSettings.height	formData			Preview image heigth.
previewSettings.jpegQuality	formData			Quality of Jpeg previews.
previewSettings.fitMode	formData			Image preview fit mode.
previewSettings.interpolationMode	formData			Image preview interpolation mode.
previewSettings.background	formData			Background color for transparent images.
*sourceFile	formData			Image source file.

Responses

Status Code	Type	Description	Samples
201	ImageDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

PrivateMockupProcessor

Using these endpoints, you may process private mockups (created by the end users) - for example, import it to the storage, generate a preview or update its metadata.

PreparePreview

Creates preview image for mockup taken from private storage.

In case when preview is already existed returns existed preview.

Request

GET /api/processor/v1/private-mockups/{id}/preview/{namespace}/{name}/{width}x{height}[?jpegQuality&fitMode&interpolationMode&background&force&tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source mockup entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
jpegQuality	query			Jpeg preview quality.
fitMode	query			Preview fit mode.
interpolationMode	query			Preview interpolation mode.
background	query			Color to replace transparent background (e.g. 'White').
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

PreparePreviewUrl

Creates preview image for mockup taken from private storage.

In case when preview is already existed returns existed preview

Request

GET /api/processor/v1/private-mockups/{id}/preview/{namespace}/{name}/{width}x{height}/url[?jpegQuality&fitMode&interpolationMode&background&force&tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Source mockup entity identifier.
*namespace	path			Preview namespace.
*name	path			Preview name.
*width	path			Preview image width.
*height	path			Preview image height.
jpegQuality	query			Jpeg preview quality.
fitMode	query			Preview fit mode.
interpolationMode	query			Preview interpolation mode.
background	query			Color to replace transparent background (e.g. 'White').
force	query		False	If set to 'true', new preview prepared, even if preview already existed.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden

Update

Updates mockup file and metadata in private storage

If file is not provided metadata will be updated using file taken from storage

Request

POST /api/processor/v1/private-mockups/{id}/update[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
*id	path			Mockup entity unique identifier.
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
name	formData			Mockup name.
path	formData			Mockup location (folder path).
customFields	formData			Mockup custom attributes.
file	formData			Mockup source file.

Responses

Status Code	Type	Description	Samples
200	MockupDto	Success
404	ProblemDetails	Not Found
409	ProblemDetails	Conflict
401		Unauthorized
403		Forbidden

ImportMockup

Imports mockup from source file and saves it to private storage.

Request

POST /api/processor/v1/private-mockups/import[?tenantId&ownerId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
ownerId	query			Private storage owner identifier.
name	formData			Mockup name.
path	formData			Mockup location (folder path).
customFields	formData			Mockup custom attributes.
previewSettings.makePreview	formData			Indicates if a preview is needed.
previewSettings.namespace	formData			Preview namespace.
previewSettings.name	formData			Preview name.
previewSettings.width	formData			Preview width.
previewSettings.height	formData			Preview height.
previewSettings.jpegQuality	formData			Jpeg preview quality.
previewSettings.fitMode	formData			Preview fit mode.
previewSettings.interpolationMode	formData			Preview interpolation mode.
previewSettings.background	formData			Color to replace transparent background (e.g. 'white').
*sourceFile	formData			Mockup source file.
type	formData			Mockup type.

Responses

Status Code	Type	Description	Samples
201	MockupDto	Success
409	NameConflictDto	Conflict
401		Unauthorized
403		Forbidden

Definitions

BuildInfoModel

Information about a service.

Name	Type	Notes
version	string	Version number.
buildDate	string	Build date (UTC).
configuration	string	Build configuration (Debug | Release).
appName	string	Service name.
designAtomsVersion	string	Aurigma.DesignAtoms version.
designAtomsModelVersion	string	Aurigma.DesignAtoms.Model version.

ColorProfileDto

Name	Type	Notes
metadata	ColorProfileMetadata[]
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

ColorProfileMetadata

Name	Type	Notes
description	string
model	string
copyright	string
manufacturer	string
colorSpace
deviceClass

ProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string

NameConflictDto

Name	Type	Notes
type	ConflictType
id	string
name	string
path	string

ConflictType

Enum Values

Name FolderOverwrite

DataSchemaLinksInfo

Information about data schema links

Name	Type	Notes
designs	DataSchemaLink[]	List of data schema link descriptions for designs linked to data schema
dataSets	DataSchemaLink[]	List of data schema link descriptions for data sets linked to data schema

DataSchemaLink

List of data schema link descriptions for designs linked to data schema

Name	Type	Notes
id	string	Identifier of entity which is linked to data schema
name	string	Name of entity which is linked to data schema

DataSchemaDto

Name	Type	Notes
metadata	DataSchemaMetadata[]
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

DataSchemaMetadata

Name	Type	Notes
fields	string

DataSetProblemInfo

Information about data set problems

Name	Type	Notes
dataValidationProblems	DataSetValidationProblemDescription[]	List of data validation problem descriptions
dataSetSchemaMissingProblem	DataSetSchemaMissingProblemDescription[]	List of font missing problem descriptions

DataSetValidationProblemDescription

List of data validation problem descriptions

Name	Type	Notes
rowIndex	integer (int32)	Index of data set row holding the item which violates validation rule
columnName	string	Name of data set column holding the item which violates validation rule
validationRule	DataSchemaValidationRule	Validation rule which is voilated
reason	string	Violation description

DataSchemaValidationRule

Validation rule which is voilated

Enum Values

Ok Missing Required NoSuchField StringPattern StringMinLength StringMaxLength StringMinLengthPerLine StringMaxLengthPerLine StringMinLines StringMaxLines NumberIsNumber NumberMin NumberMax NumberIsInteger VariantNotInList ImageRoot ImageNotFound

DataSetSchemaMissingProblemDescription

List of font missing problem descriptions

Name	Type	Notes
dataSchemaName	string	Name of missed data schema

DataSetDto

Name	Type	Notes
metadata	DataSetMetadata[]
hasProblems	boolean
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

DataSetMetadata

Name	Type	Notes
dataSchemaId	string
dataSchemaName	string
rowCount	integer (int32)

DataSetExtractDataSchemaModel

Extract data schema operation parameters.

Name	Type	Notes
name	string	Data schema name.
path	string	Data schema location (folder path).

DataSetLinkDataSchemaModel

Link schema operation parameters.

Name	Type	Notes
schemaId	string	Data schema ID.

DesignCountPerSheetCalculationModel

Model to calculate the design count per sheet of the specified size.

Name	Type	Notes
sheetWidth	integer (int32)	Sheet width (in mm).
sheetHeight	integer (int32)	Sheet height (in mm).
printAreaIndex	integer (int32)	Index of print area.
margin		Print margin.
gap		Print gap.

DesignCountPerSheetCalculationResultDto

Result of calculating the design count per sheet of the specified size.

Name	Type	Notes
designCount	integer (int32)	Design count.

DesignProblemInfo

Information about design problems.

Name	Type	Notes
fontMissingProblems	DesignFontMissingProblemDescription[]	List of font missing problem descriptions.
dataValidationProblems	DesignDataValidationProblemDescription[]	List of data validation problem descriptions.
dataSchemaMissingProblem	DesignDataSchemaMissingProblemDescription[]	Data schema missing problem description.
toggleSetMissingProblem	DesignToggleSetMissingProblemDescription[]	Toggle set missing problem description.
toggleSetValidationProblem	DesignToggleSetValidationProblemDescription[]	Toggle set validation problem description.

DesignFontMissingProblemDescription

List of font missing problem descriptions.

Name	Type	Notes
postscriptName	string	Postscript name of missing font.
name	string	Name of missing font. If postcript name is known - name equals postscript name otherwise it represents available font description.

DesignDataValidationProblemDescription

List of data validation problem descriptions.

Name	Type	Notes
itemName	string	Name of design item which violate validation rules.
validationRule	DataSchemaValidationRule	Validation rule which is voilated.
reason	string	Violation description.

DesignDataSchemaMissingProblemDescription

Data schema missing problem description.

Name	Type	Notes
dataSchemaName	string	Name of missed data schema.

DesignToggleSetMissingProblemDescription

Toggle set missing problem description.

Name	Type	Notes
toggleSetName	string	Name of missed toggle set.

DesignToggleSetValidationProblemDescription

Toggle set validation problem description.

Name	Type	Notes
toggleSetName	string	Name of invalid toggle set.

ImageDepositPhoto

Name	Type	Notes
itemId	string	Design image item identifier
depositPhoto	DepositPhotoInfo	DepositPhotos image information

DepositPhotoInfo

DepositPhotos image information

Name	Type	Notes
id	string	DepositPhotos image identifier

DesignDto

Name	Type	Notes
metadata	DesignMetadata[]
hasProblems	boolean
private	boolean
previews	object
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

DesignMetadata

Name	Type	Notes
fonts	DesignFontMetadata[]
surfaces	DesignSurfaceMetadata[]
printAreas	DesignPrintAreaMetadata[]
hasDataSchema	boolean
dataSchemaId	string
dataSchemaName	string
hasToggleSet	boolean
toggleSetId	string
toggleSetName	string

DesignFontMetadata

Name	Type	Notes
postscriptName	string
family	string
style	string

DesignSurfaceMetadata

Name	Type	Notes
width	number (float)
height	number (float)

DesignPrintAreaMetadata

Name	Type	Notes
width	number (float)
height	number (float)

DesignImportConflictDto

Name	Type	Notes
missingFontsConflict	MissingFontsConflictDto[]
missingImagesConflict	MissingImagesConflictDto[]
nameConflict	NameConflictDto[]

MissingFontsConflictDto

Name	Type	Notes
fontInfos	MissingFontInfo[]

MissingFontInfo

Name	Type	Notes
postscriptName	string

MissingImagesConflictDto

Name	Type	Notes
imageInfos	MissingImageInfo[]

MissingImageInfo

Name	Type	Notes
imageFileName	string

DesignExtractDataSchemaModel

Extract data schema operation parameters.

Name	Type	Notes
name	string	Data schema name.
path	string	Data schema location (folder path).

DesignLinkDataSchemaModel

Link schema operation parameters.

Name	Type	Notes
schemaId	string	Data schema id.

DesignExtractToggleSetModel

Extract toggle set operation parameters.

Name	Type	Notes
name	string	Toggle set name.
path	string	Toggle set location (folder path).

DesignLinkToggleSetModel

Link toggle set operation parameters.

Name	Type	Notes
toggleSetId	string	Toggle set id.

DesignUpdateConflictDto

Name	Type	Notes
missingFontsConflict	MissingFontsConflictDto[]
missingImagesConflict	MissingImagesConflictDto[]
nameConflict	NameConflictDto[]

CreateBlankDesignModel

Operation parameters.

Name	Type	Notes
designParams		Design prameters.
previewSettings		Design preview settings.
blankDesignSettings		Blank design settings.

CreateDesignFromMockupModel

Operation parameters.

Name	Type	Notes
designParams		Design prameters.
previewSettings		Design preview settings.
mockupId	string	Mockup identifier.

ValidationResultDto

Validation result.

Name	Type	Notes
isValid	boolean	Indicates if the validation was successful.
errors	array	List of validation errors.

DocumentDto

Name	Type	Notes
type	DocumentType
format	DocumentFormatType
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

DocumentType

Enum Values

General Config ToggleSet

DocumentFormatType

Enum Values

Binary Json Xml Protobuf

ImportDocumentConflictDto

Name	Type	Notes
nameConflict	NameConflictDto[]
validationConflict	DocumentValidationConflictDto[]

DocumentValidationConflictDto

Name	Type	Notes
validationMessage	string

CreateBlankToggleSetModel

Operation parameters.

Name	Type	Notes
name	string	Toggle set name.
path	string	Toggle set location (folder path).
customFields	object	Toggle set custom attributes.

FontDto

Name	Type	Notes
metadata	FontMetadata[]
previews	object
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

FontMetadata

Name	Type	Notes
postscriptName	string
family	string
style	string

ImageDto

Name	Type	Notes
metadata	ImageMetadata[]
private	boolean
mimeType	string
previews	object
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

ImageMetadata

Name	Type	Notes
isVector	boolean
width	integer (int32)
height	integer (int32)
format	string
dpiX	string
dpiY	string
pages	ImagePageMetadata[]

ImagePageMetadata

Name	Type	Notes
width	integer (int32)
height	integer (int32)

MockupDto

Name	Type	Notes
metadata	MockupMetadataDto[]
private	boolean
type	MockupType
previews	object
size	integer (int64)
descriptor	string
folderId	string
tenantId	integer (int32)
id	string
ownerId	string
name	string
customFields	object
lastModified	string (date-time)

MockupMetadataDto

Name	Type	Notes
format

MockupType

Enum Values

Mockup2D Mockup3D

CopyDesignFromPublicDesignModel

Operation parameters.

Name	Type	Notes
publicDesignId	string	Public design identifier (defines copy source).
resultDesignId	string	Design identifier (defines desired identifier of a result design).
resultDesignParams		Design prameters (defines desired parameters of a result design).

CopyDesignFromPublicResourceModel

Operation parameters.

Name	Type	Notes
publicResourceId	string	Public resource identifier (defines copy source).
resultDesignId	string	Design identifier (defines desired identifier of a result design).
resultDesignParams		Design prameters (defines desired parameters of a result design).