Get Image Settings

Post


/api/3/UploadImage/GetImageSettings?websiteId={websiteId}&webApiClientKey={webApiClientKey}

The Get Image Settings API provides the configuration details for image uploads within the Artifi platform. This API helps retrieve settings like allowed file extensions, maximum file size, image dimensions, and DPI (dots per inch) for the images associated with the website.

Request Information

Parameters

Parameter Name

Description

WebsiteId (Int)

This param refers to the website associated with customized products.

The admin user of Artifi can create one or more websites and assign products to each of them. The ID of the website with which specified customized products are associated should be specified in this parameter.

WebApiClientKey (String)

When any company registers with Artifi, Artifi will generate a special and unique key for that company, which will be called the client key.

This client key can be found in the registered company's profile tab in the Artifi Account.

The client key will be used for client (company) authentication and will be referred to as WebApiClientKey.

Response Information

Response body formats

On Success

On success, this method will call back the JavaScript method in the website which is specified in the "successCallback" parameter with errorMessage.

Success Response:

{

  "Response": "Success",

  "Message": "",

  "Data": {

    "FileSize": 5,

    "ImageExtensions": "JPEG,JPG,PNG",

    "Dimension": {

      "Width": 3000,

      "Height": 3000

    },

    "ImageDPI": 90,

    "UserPhotoImageWidth": 0,

    "UserPhotoImageHeight": 0

  },

  "ErrorCode": ""

}

On Error

On error, this method will call back the JavaScript method in the website which is specified in the "errorCallback" parameter with errorMessage.

Error Response:

{

  "Response": "Error",

  "Message": "Invalid website id.",

  "Data": null,

  "ErrorCode": "221,234"

}

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.