Design Atoms API

Use this API when you are working with Design Atoms SDK to build your own editor interface.

To learn more about Design Atoms, refer to the Design Atoms documentation.

Interactive API Docs

Api Clients

.Net Client

You can install it from Nuget as follows:

Install-Package Aurigma.DesignAtomsApi.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-design-atoms-api-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-design-atoms-api-client

See on npm

PHP Client

PHP client can be installed through composer as follows:

composer require aurigma/php-design-atoms-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/atoms/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
500	ProblemDetails	Internal server error

GetInfo

Get assembly build info.

Request

GET /api/atoms/v1/info

Responses

Status Code	Type	Description	Samples
200	BuildInfoModel	Success
500	ProblemDetails	Internal server error

DesignAtomsCompatibility

These endpoints are used in compatibility purposes

CssFonts

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/cssfonts

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	FontsMethodData

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

Fonts

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/fonts/{psName}

Parameters

Name	In	Type	Default	Notes
*tenantId	path
*psName	path

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

GetColorPreview

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetColorPreview

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetColorPreviewRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

GetColorPreviews

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetColorPreviews

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetColorPreviewsRequest

Responses

Status Code	Type	Description	Samples
200	GetColorPreviewsResponse	Success
500	ProblemDetails	Internal server error

GetCssFont

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetCssFont[?fontKey]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
fontKey	query

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

GetFallbackFonts

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetFallbackFonts

Parameters

Name	In	Type	Default	Notes
*tenantId	path

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

GetImageSize

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetImageSize

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetImageSizeRequest

Responses

Status Code	Type	Description	Samples
200	NullAbleSize	Success
500	ProblemDetails	Internal server error

GetShapeBounds

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetShapeBounds

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	GetShapeBoundsRequest

Responses

Status Code	Type	Description	Samples
200	RectangleF	Success
500	ProblemDetails	Internal server error

GetWatermarkItems

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetWatermarkItems

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

Img

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/img[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

GetLicense

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/license

Parameters

Name	In	Type	Default	Notes
*tenantId	path

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

Pth

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/pth[?f]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

Resource

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/resource[?image]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
image	query

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

Svg

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/svg[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

Txt

Request

GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/txt[?f]

Parameters

Name	In	Type	Default	Notes
*tenantId	path
f	query

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

UpdateArchedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateArchedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateAutoScaledTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateAutoScaledTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateBarcodeItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBarcodeItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateBoundedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBoundedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateByColorData

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByColorData

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateColorsRequest

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

UpdateByMultiCallRequest

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByMultiCallRequest

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	MultiCallRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateCurvedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateCurvedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateImageItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateImageItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateImageHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdatePathBoundedTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePathBoundedTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdatePlainTextItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePlainTextItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateShapeItemHandler

Request

POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateShapeItemHandler

Parameters

Name	In	Type	Default	Notes
*tenantId	path
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

DesignAtomsImages

These endpoints are used to manipulate images via Design Atoms.

RenderImagePreview

Renders a web image preview with the specified parameters.

Request

POST /api/atoms/v1/images/render-preview[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderImagePreviewModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

RenderImagePreviewToResource

Renders a web image preview with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/images/render-preview/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	RenderImagePreviewToResourceModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

DesignAtomsMockups3d

These endpoints are used to manipulate 3D-Mockups via Design Atoms.

GetAttributes

Returns a 3D-Mockup attributes.

Request

GET /api/atoms/v1/mockups-3d/{id}/attributes[?ownerId&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			3D-Mockup identifier.
ownerId	query			Private mockup owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	Mockup3dAttributesDto	Success
404	ProblemDetails	Not Found
422	ProblemDetails	Client Error
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

GetContentAsProtobuf

Returns a 3D-Mockup content as protobuf binary stream.

Request

GET /api/atoms/v1/mockups-3d/{id}/content/as-protobuf[?ownerId&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			3D-Mockup identifier.
ownerId	query			Private mockup owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
422	ProblemDetails	Client Error
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

GetGeometryFile

Returns a 3D-Mockup geometry as binary stream.

Request

GET /api/atoms/v1/mockups-3d/{id}/geometry/file[?ownerId&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			3D-Mockup identifier.
ownerId	query			Private mockup owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
422	ProblemDetails	Client Error
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

DesignAtomsService

These endpoints are used to manipulate Design Atoms models

CreateDesign

Creates new design file with specified parameters and saves it in storage.

Request

POST /api/atoms/v1/designs[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier
body	body	CreateDesignModel		Design creation parameters

Responses

Status Code	Type	Description	Samples
201	DesignInfo	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

ExtractBackground

Returns content of the background.

Request

GET /api/atoms/v1/designs/{id}/background[?surfaceIndex&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
surfaceIndex	query			Surface index.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	MissingDesignElementDto	Not Found
422	UnprocessableDesignElementDto	Client Error
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

LoadProduct

Loads product (design model) from design file taken from storage

Request

GET /api/atoms/v1/designs/{id}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

SaveProduct

Saves product (design model) to design file and updates design in storage.

Request

PUT /api/atoms/v1/designs/{id}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier
body	body			Serialized product description

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

PatchProduct

Patches product (design model) in design file.

Design with specified identifier must exist at desired storage.

Request

PATCH /api/atoms/v1/designs/{id}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier.
privateStorageOwner	query			Private storage owner identifier.
tenantId	query			Tenant identifier
patchType	formData			Patch operation type.
replaceImageItemFileInfo.itemName	formData			Item Name.
replaceImageItemFileInfo.sourceFile	formData			Patch source file.
replacePlaceholderItemContentInfo.placeholderItemName	formData			Item Name.
replacePlaceholderItemContentInfo.newContentType	formData			New content type.
replacePlaceholderItemContentInfo.sourceFile	formData			Patch source file.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

GetDesignParameters

Returns design parameters stored in product model.

Request

GET /api/atoms/v1/designs/{id}/parameters[?privateStorageOwner&tenantId]

Parameters

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

Responses

Status Code	Type	Description	Samples
200	DesignParameters	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

LoadDataSchema

Loads data schema from design file taken from storage

Request

GET /api/atoms/v1/designs/{id}/schema[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
409	ProblemDetails	Conflict
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

LoadToggleSet

Loads toggle set from design file taken from storage.

Request

GET /api/atoms/v1/designs/{id}/toggle-set[?privateStorageOwner&tenantId]

Parameters

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

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
409	ProblemDetails	Conflict
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

GetVariables

Gets variable items information for design file taken from storage

Request

GET /api/atoms/v1/designs/{id}/variables[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	VariablesModel	Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

SetVariables

Sets variable items values for design file taken from storage

Request

PUT /api/atoms/v1/designs/{id}/variables[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier
body	body	VariablesModel		Design variable values

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
409	ProblemDetails	Conflict
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

LoadVdpData

Loads variable data printing information from design file taken from storage

Request

GET /api/atoms/v1/designs/{id}/vdp-data[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	VdpDataModel	Success
404	ProblemDetails	Not Found
409	ProblemDetails	Conflict
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

SaveVdpData

Saves variable data printing information to design file and updates design in storage.

Design with specified identifier must exist at desired storage.

Request

PUT /api/atoms/v1/designs/{id}/vdp-data[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier
body	body	VdpDataModel		Serialized vdp data

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

DeleteVdpData

Deletes variable data printing information from design file and updates design in storage.

Design with specified identifier must exist at desired storage.

Request

DELETE /api/atoms/v1/designs/{id}/vdp-data[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Design identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
409	ProblemDetails	Conflict
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

LoadProductFromResource

Loads product (design model) from resource file taken from storage

Request

GET /api/atoms/v1/designs/from-resource/{id}/model[?privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
*id	path			Resource identifier
privateStorageOwner	query			Private storage owner identifier
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
422	ProblemDetails	Client Error
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

ConvertColors

Converts colors

Request

POST /api/atoms/v1/designs/model/convert-colors[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	ConvertColorsModel		Convert colors operation parameters

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

CreateItem

Creates product item

Request

POST /api/atoms/v1/designs/model/items[?itemType&tenantId]

Parameters

Name	In	Type	Default	Notes
itemType	query			Desired item type
tenantId	query			Tenant identifier
sourceType	formData			Source type.
sourceId	formData			Source id, used if source type is 'ImageStorage' or 'PrivateImageStorage'.
sourceOwnerId	formData			Source owner id, used if source type is 'PrivateImageStorage'.
sourceFile	formData			Source file, used if source type is 'File'.

Responses

Status Code	Type	Description	Samples
200		Success
404	ProblemDetails	Not Found
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

ExtractItemImage

Extracts product item image.

Request

POST /api/atoms/v1/designs/model/items/extract-image[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	ExtractItemImageModel		Extraction parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

FlattenItems

Flatten items.

Request

POST /api/atoms/v1/designs/model/items/flatten[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	array		Items to flatten.

Responses

Status Code	Type	Description	Samples
200		Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

RenderProduct

Render product proof image with specified parameters.

Request

POST /api/atoms/v1/designs/model/render-proof[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderProductModel		Preview parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

RenderDesignPreview

Renders a design preview with the specified parameters.

Request

POST /api/atoms/v1/designs/render-preview[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderDesignPreviewModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

RenderDesignPreviewToResource

Renders a design preview with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/designs/render-preview/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	RenderDesignPreviewToResourceModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

RenderDesignProof

Renders a design proof with the specified parameters.

Request

POST /api/atoms/v1/designs/render-proof[?attachment&tenantId]

Parameters

Name	In	Type	Default	Notes
attachment	query			If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
tenantId	query			Tenant identifier
body	body	RenderDesignProofModel		Render model with proof parameters.

Responses

Status Code	Type	Description	Samples
200	string	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

RenderDesignProofToResource

Renders a design proof with the specified parameters and saves rendering result as resource.

Request

POST /api/atoms/v1/designs/render-proof/to-resource[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	RenderDesignProofToResourceModel		Render model with preview parameters.

Responses

Status Code	Type	Description	Samples
200	ResourceInfoDto	Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

CreatePrivateDesignFromDesign Deprecated

Creates a private design from a public design.

Request

POST /api/atoms/v1/private-designs/from-design[?designId&privateDesignId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
designId	query			Public design ID.
privateDesignId	query			Private design ID.
privateStorageOwner	query			Private storage owner ID.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
201		Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

CreatePrivateDesignFromResource Deprecated

Creates a private design from a public resource.

Request

POST /api/atoms/v1/private-designs/from-resource[?resourceId&privateDesignId&privateStorageOwner&tenantId]

Parameters

Name	In	Type	Default	Notes
resourceId	query			Resource ID.
privateDesignId	query			Private design ID.
privateStorageOwner	query			Private storage owner ID.
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
201		Success
401		Unauthorized
403		Forbidden
500	ProblemDetails	Internal server error

DesignAtomsViewer

These endpoints are used to manipulate Design Atoms models

CssFonts

Request

POST /api/atoms/v1/ccviewer/cssfonts[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	FontsMethodData

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

Fonts

Request

GET /api/atoms/v1/ccviewer/fonts/{psName}[?tenantId]

Parameters

Name	In	Type	Default	Notes
*psName	path
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

GetColorPreview

Request

POST /api/atoms/v1/ccviewer/GetColorPreview[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetColorPreviewRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

GetColorPreviews

Request

POST /api/atoms/v1/ccviewer/GetColorPreviews[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetColorPreviewsRequest

Responses

Status Code	Type	Description	Samples
200	GetColorPreviewsResponse	Success
500	ProblemDetails	Internal server error

GetCssFont

Request

GET /api/atoms/v1/ccviewer/GetCssFont[?fontKey&tenantId]

Parameters

Name	In	Type	Default	Notes
fontKey	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

GetFallbackFonts

Request

GET /api/atoms/v1/ccviewer/GetFallbackFonts[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

GetImageSize

Request

POST /api/atoms/v1/ccviewer/GetImageSize[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetImageSizeRequest

Responses

Status Code	Type	Description	Samples
200	NullAbleSize	Success
500	ProblemDetails	Internal server error

GetShapeBounds

Request

POST /api/atoms/v1/ccviewer/GetShapeBounds[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	GetShapeBoundsRequest

Responses

Status Code	Type	Description	Samples
200	RectangleF	Success
500	ProblemDetails	Internal server error

GetWatermarkItems

Request

POST /api/atoms/v1/ccviewer/GetWatermarkItems[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

Img

Request

GET /api/atoms/v1/ccviewer/img[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

GetLicense

Request

GET /api/atoms/v1/ccviewer/license[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

Pth

Request

GET /api/atoms/v1/ccviewer/pth[?f&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

Resource

Request

GET /api/atoms/v1/ccviewer/resource[?image&tenantId]

Parameters

Name	In	Type	Default	Notes
image	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

Svg

Request

GET /api/atoms/v1/ccviewer/svg[?f&w&h&cmyk&rgb&grayscale&target&sq&effect&kp&color&obm&oo&alphaMask&page&colorizeColor&rw&rh&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
w	query
h	query
cmyk	query
rgb	query
grayscale	query
target	query
sq	query
effect	query
kp	query
color	query
obm	query
oo	query
alphaMask	query
page	query
colorizeColor	query
rw	query
rh	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

Txt

Request

GET /api/atoms/v1/ccviewer/txt[?f&tenantId]

Parameters

Name	In	Type	Default	Notes
f	query
tenantId	query			Tenant identifier

Responses

Status Code	Type	Description	Samples
200	string	Success
304		Not Modified
404	ProblemDetails	Not Found
500	ProblemDetails	Internal server error

UpdateArchedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateArchedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateAutoScaledTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateAutoScaledTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateBarcodeItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateBarcodeItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateBoundedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateBoundedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateByColorData

Request

POST /api/atoms/v1/ccviewer/UpdateByColorData[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateColorsRequest

Responses

Status Code	Type	Description	Samples
200	string	Success
500	ProblemDetails	Internal server error

UpdateByMultiCallRequest

Request

POST /api/atoms/v1/ccviewer/UpdateByMultiCallRequest[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	MultiCallRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateCurvedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateCurvedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateImageItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateImageItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateImageHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdatePathBoundedTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdatePathBoundedTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdatePlainTextItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdatePlainTextItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

UpdateShapeItemHandler

Request

POST /api/atoms/v1/ccviewer/UpdateShapeItemHandler[?tenantId]

Parameters

Name	In	Type	Default	Notes
tenantId	query			Tenant identifier
body	body	UpdateHandlerRequest

Responses

Status Code	Type	Description	Samples
200		Success
500	ProblemDetails	Internal server error

Definitions

ProblemDetails

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

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.

FontsMethodData

Name	Type	Notes
requestedFontsByPsName	array
advancedMode	boolean
baseUrl	string

GetColorPreviewRequest

Name	Type	Notes
colorData
colorSettings

GetColorPreviewsRequest

Name	Type	Notes
colorData
colorSettings

GetColorPreviewsResponse

Name	Type	Notes
previews	RgbColor[]

RgbColor

Name	Type	Notes
colorSpace	ColorSpace
r	integer (int32)
g	integer (int32)
b	integer (int32)
alpha	integer (int32)
profile	string

ColorSpace

Enum Values

Rgb Cmyk Grayscale Lab Spot

GetImageSizeRequest

Name	Type	Notes
imageId	string
pageIndex	integer (int32)

NullAbleSize

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

GetShapeBoundsRequest

Name	Type	Notes
path	string

RectangleF

Name	Type	Notes
location	PointF[]
size	string
x	number (float)
y	number (float)
width	number (float)
height	number (float)
left	number (float)
top	number (float)
right	number (float)
bottom	number (float)
isEmpty	boolean

PointF

Name	Type	Notes
isEmpty	boolean
x	number (float)
y	number (float)

UpdateHandlerRequest

Name	Type	Notes
canvasData	string
itemHandlerData	string
itemData
colorSettings

UpdateColorsRequest

Name	Type	Notes
canvasData	string
colorData	string

MultiCallRequest

Name	Type	Notes
items	MultiCallRequestItem[]

MultiCallRequestItem

Name	Type	Notes
canvasData	string
itemHandlersData	string
colorData	string
actualSize	boolean
preserveAspectRatio	boolean
url	string
imageId	string
pageIndex	integer (int32)
methodName	string
itemData
colorSettings

UpdateImageHandlerRequest

Name	Type	Notes
actualSize	boolean
preserveAspectRatio	boolean
url	string
canvasData	string
itemHandlerData	string
itemData
colorSettings

RenderImagePreviewModel

Render model with preview parameters.

Name	Type	Notes
imageUrl	string	External image URL.
imageId	string	Storage image identifier.
ownerId	string	Storage image owner identifier.
mockupOwnerId	string	Mockup owner identifier.
mockupId	string	Mockup identifier.
renderingConfig		Image preview configuration.

RenderImagePreviewToResourceModel

Render model with preview parameters.

Name	Type	Notes
previewResourceParams		Parameters of resource that should be created for a preview rendering result.
imageUrl	string	External image URL.
imageId	string	Storage image identifier.
ownerId	string	Storage image owner identifier.
mockupOwnerId	string	Mockup owner identifier.
mockupId	string	Mockup identifier.
renderingConfig		Image preview configuration.

ResourceInfoDto

Name	Type	Notes
id	string
ownerId	string
name	string
namespace	string
private	boolean
url	string

Mockup3dAttributesDto

Name	Type	Notes
data	object

CreateDesignModel

Design creation parameters

Name	Type	Notes
product		Serialized product description.
dataSchema	string	Serialized product data schema (base64 file stream).
name	string	Design name.
path	string	Design location (folder path).

DesignInfo

Name	Type	Notes
id	string
ownerId	string
name	string
private	boolean

MissingDesignElementDto

Name	Type	Notes
description	string	Problem description.
missingElementType	DesignElementType	Missing element type.

DesignElementType

Missing element type.

Enum Values

Product Design Surface Container PrintArea Item

UnprocessableDesignElementDto

Name	Type	Notes
description	string	Problem description.
missingElementType	DesignElementType	Missing element type.

DesignParameters

Specific design parameters stored in product model.

Name	Type	Notes
measureUnit	MeasureUnitInfo[]	Design measure unit description.
designAtomsVersion	string	Version of DesignAtoms library that used to save design file.

MeasureUnitInfo

Design measure unit description.

Name	Type	Notes
name	string	Measure unit name.
shortName	string	Measure unit short name.
ratio	number (float)	Measure unit ratio (to point).

VariablesModel

Variables information.

Name	Type	Notes
items	VariableInfo[]	List of variables.

VariableInfo

List of variables.

Name	Type	Notes
name	string	Variable name.
value	string	Variable value.
type	string	Variable type.

VdpDataModel

Variable data printing information.

Name	Type	Notes
vdpDataSet		Serialized vdp dataset.
vdpItemsData		Serialized vdp items data.

ConvertColorsModel

Convert colors operation parameters

Name	Type	Notes
colors	array	Serialized color description.
sourceColorProfile	string	Source color profile description.
destinationColorProfile	string	Destination color profile description.
targetDeviceColorProfile	string	Targent color profile description.

ExtractItemImageModel

Extraction parameters.

Name	Type	Notes
item		Serialized item description.

RenderProductModel

Preview parameters.

Name	Type	Notes
product		Serialized product description.
renderingConfig		Proof Image rendering config.

RenderDesignPreviewModel

Render model with preview parameters.

Name	Type	Notes
designId	string	Design ID. Used to get design file from public or private storage.
mockupId	string	Mockup ID. Used to get mockup file from public storage.
ownerId	string	ID of the design owner.
mockupOwnerId	string	ID of the mockup owner.
renderingConfig		Rendering configuration for getting a preview of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the preview image.

RenderDesignPreviewToResourceModel

Render model with preview parameters.

Name	Type	Notes
previewResourceParams		Parameters of resource that should be created for a preview rendering result.
designId	string	Design ID. Used to get design file from public or private storage.
mockupId	string	Mockup ID. Used to get mockup file from public storage.
ownerId	string	ID of the design owner.
mockupOwnerId	string	ID of the mockup owner.
renderingConfig		Rendering configuration for getting a preview of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the preview image.

RenderDesignProofModel

Render model with proof parameters.

Name	Type	Notes
designId	string	Design ID. Used to get design file from public or private storage.
ownerId	string	ID of the design owner.
renderingConfig		Rendering configuration for getting a proof image of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the proof image.

RenderDesignProofToResourceModel

Render model with preview parameters.

Name	Type	Notes
proofResourceParams		Parameters of resource that should be created for a preview rendering result.
designId	string	Design ID. Used to get design file from public or private storage.
ownerId	string	ID of the design owner.
renderingConfig		Rendering configuration for getting a proof image of design.
variableData	VariableInfo[]	Variable (user) data for design variable fields in the proof image.