GetImage API Signature
{DomainName}/Designer/Image/GetImage?websiteId={websiteId}&webApiClientKey= {webApiClientKey}&sku={Artifi Product SKU}or{StyleNumber}or{StyleNumber_OmsCode}
Example:
Product Image
Product Image With Width & Height:
Product Image With OMS Color :
Product Image With OMS Color & Max Logo Decoration Area:
Product Image With OMS Color & Requested Logo Decoration Area:
Using this API, you can get an image as per the parameters.
Enable CDN Cache
If the cache is disabled for the website from Artifi Admin, in that case, the following GetImage API URL needs to be used.
{DomainName}/Designer/Image/GetImage/NoCache?websiteId={websiteId}&webApiClientKey= {webApiClientKey}&sku={Artifi Product SKU}or{StyleNumber}or{StyleNumber_OmsCode}
Note: Pass decoration JSON in encoded format.
Request Information
Parameters
Name | Descriptions |
| website | This is the website created in the Artifi account. |
webApiClientKey | When any company gets registered with Artifi, Artifi will generate a special and unique key for that company which will be called a client key. This client key can be found in the registered company's profile tab in Artifi Admin Account. |
| Artifi Product SKU/StyleNumber/StyleNumber_OmsCode | This is a unique field to identify any product. In this field, users can send either Product base SKU/ProductCode or Variant SKU. This field should be matched with the product available in Admin. If Artifi receives the base product code/SKU and the product has variants, then we are sending back the default SKU details of that product. |
| viewCode [Optional] | Optional field for GetImage API. This becomes mandatory when a specific view needs to be pulled. Otherwise, the default view image will be pulled. |
| angleCode [Optional] | Optional field for GetImage API. This becomes mandatory when a specific angle needs to be pulled. Otherwise, the default angle image will be pulled. |
| width [Optional] | The width of the output image. |
| height [Optional] | The height of the output image. |
| conversionUnit=In/px [Optional] | This param is used for applying decoration in inches or pixels. The default value is Px. |
| format [Optional] | Format of the output image. Default extension/format of image is .png |
| isProductImage[Optional] | This flag is used to get product base image forcefully. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isIgnoreAspectRatio[Optional] | If the user needs an output image in exact width and height then this flag will be enabled, otherwise, it resizes the image according to aspect ratio. The default value of this flag is false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| isDesignImage[Optional] | This flag is used for getting only design details. The default value of this flag is always false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dpi[Optional] | Output image DPI value. Default is 72 DPI | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IsZoom[Optional] | This parameter is used to get an image of high resolution. If its value is true then we will return a high-resolution image with a given height-width. If it is false then it will return a low-resolution image to 600px width and height. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| templateCode[Optional] | This parameter is used to get an image of a particular template apart from the default applied template to any view. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parameters[Optional] | In order to apply any decoration over the product image/ view image, you need to pass these params in JSON encoded format. Ex. parameters= [{ "type":"textbox", "widget_key":"CL_Text", "text":"DJP", "fill":"#951357", "fontFamily":"Impact", "fontWeight":"normal", "vAlign":"middle","left":200.29,"top":200.44,"width":200.96,"height": 164.48,"dm_code":"DE" },{ "type":"image","src":"4","widget_key":"CR_Image","left":200.29,"top":200.44,"width":200.96, "height":164.48,"dm_code":"DE"}] Note : Pass decoration JSON in encoded format. Text Properties
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Decorationmethodcode (Optional) | In order to apply the embroidery effect to the product, on the basis of the decoration method code. |