Lumaprints API

Check image

POST/api/v1/images/checkImageConfig

Check if the image is sized correctly based on the provided width, height and options. You don't need to call this endpoint every time you submit an order. The submit order endpoint automatically verifies if the images meet the required dimensions.

Request

Authorization: Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string [{Username]}:[{Password]}

Example

Authorization: Basic YWRtaW46MTIzNDU2

subcategoryId

number

required

The subcategory of the product to check the image against.

Example:

101001

printWidth

number

required

The width of the print to check the image against in inches.

Example:

printHeight

number

required

The height of the print to check the image against in inches.

Example:

imageUrl

string <string>

required

The URL of the image of the order item.

>= 6 characters<= 1024 characters

Example:

https://www.example.com/image.jpg

orderItemOptions

array[string <array>]

required

The ID of options of the product to check the image against.

Example:

[1,11,21]

{
  "subcategoryId": "101001",
  "printWidth": "8",
  "printHeight": "8",
  "imageUrl": "https://www.example.com/image.jpg",
  "orderItemOptions": [
    1,
    11,
    21
  ]
}

Request samples

Responses

The image is sized correctly.(200)

The image URL is invalid or not accessible.(400)

The image is sized incorrectly.(406)

The image is sized correctly.

HTTP Code: 200

Content Type : JSONapplication/json

message

string <string>

required

Message indicating if the image is sized correctly.

Examples:

The aspect ratio of the image is the same as the ordered size. We allow a maximum of 1% difference between the aspect ratio of the image and the ordered size.The aspect ratio of the image is not same as the ordered size. We only allow a maximum of 1% difference between the aspect ratio of the image and the ordered size.

imageUrl

string <string>

required

The URL of the image

Example:

https://www.example.com/image.jpg

recommendedWidth

number

required

The width of the print was checked against the image in pixels.

Example:

1600

recommendedHeight

number

required

The height of the print was checked against the image in pixels.

Example:

2400

expectedAspectRatio

string

required

The expected aspect ratio of the image.

Example:

2:3

actualImageWidth

number

required

The actual width of the image in pixels.

Example:

1600

actualImageHeight

number

required

The actual height of the image in pixels.

Example:

2400

actualImageAspectRatio

string

required

The actual aspect ratio of the image.

Example:

2:3

{
  "message": "The aspect ratio of the image is the same as the ordered size. We allow a maximum of 1% difference between the aspect ratio of the image and the ordered size.",
  "imageUrl": "https://www.example.com/image.jpg",
  "recommendedWidth": 1600,
  "recommendedHeight": 2400,
  "expectedAspectRatio": "2:3",
  "actualImageWidth": 1600,
  "actualImageHeight": 2400,
  "actualImageAspectRatio": "2:3"
}

Last modified: a year ago