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.
Api Clients
.Net Client
You can install it from Nuget as follows:
Install-Package Aurigma.DesignAtomsApi.ApiClient
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
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
PHP Client
PHP client can be installed through composer as follows:
composer require aurigma/php-design-atoms-client
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 |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
500 |
|
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 |
|
Not Found |
|
500 |
|
Internal server error |
GetColorPreview
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetColorPreview
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
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 |
|
Not Found |
|
500 |
|
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 |
|
Internal server error |
GetImageSize
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetImageSize
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
500 |
|
Internal server error |
GetShapeBounds
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetShapeBounds
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
500 |
|
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 |
|
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]
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 |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
304 | Not Modified |
||
404 |
|
Not Found |
|
500 |
|
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 |
|
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 |
|
Not Found |
|
500 |
|
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 |
|
Not Found |
|
500 |
|
Internal server error |
Svg
Request
GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/svg[?f]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
f | query |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
304 | Not Modified |
||
404 |
|
Not Found |
|
500 |
|
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 |
|
Not Found |
|
500 |
|
Internal server error |
UpdateArchedTextItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateArchedTextItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateAutoScaledTextItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateAutoScaledTextItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateBarcodeItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBarcodeItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateBoundedTextItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBoundedTextItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateByColorData
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByColorData
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
500 |
|
Internal server error |
UpdateByMultiCallRequest
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByMultiCallRequest
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateCurvedTextItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateCurvedTextItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateImageItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateImageItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdatePathBoundedTextItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePathBoundedTextItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdatePlainTextItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePlainTextItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateShapeItemHandler
Request
POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateShapeItemHandler
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*tenantId | path | |||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
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-image-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 |
|
Render model with preview parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
DesignAtomsMockups3d
These endpoints are used to manipulate 3D-Mockups via Design Atoms.
GetContentAsProtobuf
Returns a 3D-Mockup content as protobuf binary stream.
Request
GET /api/atoms/v1/mockups-3d/{id}/content/as-protobuf[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | 3D-Mockup identifier. |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
422 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
GetGeometryFile
Returns a 3D-Mockup geometry as binary stream.
Request
GET /api/atoms/v1/mockups-3d/{id}/geometry/file[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | 3D-Mockup identifier. |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
422 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
DesignAtomsService
These endpoints are used to manipulate Design Atoms models
ConvertColors
Converts colors
Request
POST /api/atoms/v1/colorConverter[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Convert colors operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
CreateDesign
Creates new design file with specified parameters and saves it in storage.
Request
POST /api/atoms/v1/designs[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
privateStorage | query | If set to 'true' design will be saved to private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
||
body | body |
|
Design creation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
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 |
|
Not Found |
|
422 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
LoadProduct
Loads product (design model) from design file taken from storage
If privateStorage is not set then special design search procedure activated. It tries to get specified design from public storage, and if design is not found then checks private storage
Request
GET /api/atoms/v1/designs/{id}/model[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
SaveProduct
Saves product (design model) to design file and updates design in storage.
Design with specified identifier must exist at desired storage. If 'privateStorage' parameter is not set, then special design search procedure activated. It tries to find design with specified identifier in public storage, and if it is not there, then checks private storage If design found anywhere, it will be updated
Request
PUT /api/atoms/v1/designs/{id}/model[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be saved to private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
||
body | body | Serialized product description |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
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[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier. |
||
privateStorage | query | If set to 'true' design will be taken from private storage. |
||
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 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
LoadDataSchema
Loads data schema from design file taken from storage
Request
GET /api/atoms/v1/designs/{id}/schema[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
GetVariables
Gets variable items information for design file taken from storage
Request
GET /api/atoms/v1/designs/{id}/variables[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
SetVariables
Sets variable items values for design file taken from storage
Request
PUT /api/atoms/v1/designs/{id}/variables[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
||
body | body |
|
Design variable values |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
LoadVdpData
Loads variable data printing information from design file taken from storage
Request
GET /api/atoms/v1/designs/{id}/vdpData[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
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}/vdpData[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
||
body | body |
|
Serialized vdp data |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
DeleteVdpData
Deletes variable data printing inforamtion from design file and updates design in storage.
Design with specified identifier must exist at desired storage.
Request
DELETE /api/atoms/v1/designs/{id}/vdpData[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Design identifier |
||
privateStorage | query | If set to 'true' design will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
FlattenItems
Flatten items.
Request
POST /api/atoms/v1/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 |
|
Internal server error |
CreateItem
Creates product item
Request
POST /api/atoms/v1/itemCreator[?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 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
CreatePrivateDesignFromDesign
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 |
|
Internal server error |
CreatePrivateDesignFromResource
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 |
|
Internal server error |
RenderDesignPreview
Renders a design preview with the specified parameters.
Request
POST /api/atoms/v1/render-design-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 |
|
Render model with preview parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
RenderDesignProof
Renders a design proof with the specified parameters.
Request
POST /api/atoms/v1/render-design-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 |
|
Render model with proof parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
RenderProduct
Render product proof image with specified parameters.
Request
POST /api/atoms/v1/renderer[?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 |
|
Preview parameters. |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
Internal server error |
LoadProductFromResource
Loads product (design model) from resource file taken from storage
If privateStorage is not set then special resource search procedure activated. It tries to get specified resource from public storage, and if resource is not found then checks private storage
Request
GET /api/atoms/v1/resources/{id}/as-design/model[?privateStorage&privateStorageOwner&tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Resource identifier |
||
privateStorage | query | If set to 'true' resource will be taken from private storage |
||
privateStorageOwner | query | Private storage owner identifier |
||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
422 |
|
Client Error |
|
401 | Unauthorized |
||
403 | Forbidden |
||
500 |
|
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 |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
500 |
|
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 |
|
Not Found |
|
500 |
|
Internal server error |
GetColorPreview
Request
POST /api/atoms/v1/ccviewer/GetColorPreview[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
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 |
|
Not Found |
|
500 |
|
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 |
|
Internal server error |
GetImageSize
Request
POST /api/atoms/v1/ccviewer/GetImageSize[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
500 |
|
Internal server error |
GetShapeBounds
Request
POST /api/atoms/v1/ccviewer/GetShapeBounds[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
500 |
|
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 |
|
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&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 | |||
tenantId | query | Tenant identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
304 | Not Modified |
||
404 |
|
Not Found |
|
500 |
|
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 |
|
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 |
|
Not Found |
|
500 |
|
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 |
|
Not Found |
|
500 |
|
Internal server error |
Svg
Request
GET /api/atoms/v1/ccviewer/svg[?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 |
|
Not Found |
|
500 |
|
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 |
|
Not Found |
|
500 |
|
Internal server error |
UpdateArchedTextItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdateArchedTextItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateAutoScaledTextItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdateAutoScaledTextItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateBarcodeItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdateBarcodeItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateBoundedTextItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdateBoundedTextItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateByColorData
Request
POST /api/atoms/v1/ccviewer/UpdateByColorData[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | string | Success |
|
500 |
|
Internal server error |
UpdateByMultiCallRequest
Request
POST /api/atoms/v1/ccviewer/UpdateByMultiCallRequest[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateCurvedTextItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdateCurvedTextItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateImageItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdateImageItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdatePathBoundedTextItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdatePathBoundedTextItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdatePlainTextItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdatePlainTextItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
UpdateShapeItemHandler
Request
POST /api/atoms/v1/ccviewer/UpdateShapeItemHandler[?tenantId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
tenantId | query | Tenant identifier |
||
body | body |
|
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
500 |
|
Internal server error |
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
Gets 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 |
|
500 |
|
Internal server error |
GetInfo
Gets assembly build info
Request
GET /api/atoms/v1/info
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
500 |
|
Internal server error |
Definitions
FontsMethodData
Name | Type | Notes |
---|---|---|
requestedFontsByPsName | array | |
advancedMode | boolean | |
baseUrl | string |
ProblemDetails
Name | Type | Notes |
---|---|---|
type | string | |
title | string | |
status | integer (int32) | |
detail | string | |
instance | string |
GetColorPreviewRequest
Name | Type | Notes |
---|---|---|
colorData |
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 |
|
|
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 |
UpdateColorsRequest
Name | Type | Notes |
---|---|---|
canvasData | string | |
colorData | string |
MultiCallRequest
Name | Type | Notes |
---|---|---|
items |
|
MultiCallRequestItem
Name | Type | Notes |
---|---|---|
canvasData | string | |
itemHandlersData | string | |
colorData | string | |
actualSize | boolean | |
preserveAspectRatio | boolean | |
url | string | |
imageId | string | |
pageIndex | integer (int32) | |
methodName | string | |
itemData |
UpdateImageHandlerRequest
Name | Type | Notes |
---|---|---|
actualSize | boolean | |
preserveAspectRatio | boolean | |
url | string | |
canvasData | string | |
itemHandlerData | string | |
itemData |
RenderImagePreviewModel
Render model with preview parameters.
Name | Type | Notes |
---|---|---|
imageUrl | string | External image URL. |
height | integer (int32) | Height of preview image. |
width | integer (int32) | Width of preview image. |
fileFormat | Output image format. PNG by default. |
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 |
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 |
|
Missing element type. |
DesignElementType
Missing element type.
Enum Values
Product Design Surface Container PrintArea Item
UnprocessableDesignElementDto
Name | Type | Notes |
---|---|---|
description | string | Problem description. |
missingElementType |
|
Missing element type. |
VariablesModel
Variables information
Name | Type | Notes |
---|---|---|
items |
|
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 |
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. |
renderingConfig | Rendering configuration for getting a preview of design. |
|
variableData |
|
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 |
|
Variable (user) data for design variable fields in the proof image. |
RenderProductModel
Preview parameters.
Name | Type | Notes |
---|---|---|
product | Serialized product description |
|
renderingConfig | Proof Image rendering config |
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 |