Spectrum Integration
  • Introduction
  • Ecommerce
    • Front End Integration
    • Load Design
    • Add to Cart
    • Save Design
    • Generate Cart Item
    • Pricing & Availability
    • Order Acknowledgement
    • Shipment Notification
    • Update Order Status
    • Order Search
    • Integration Driver
    • Production Related File Delivery
    • Spectrum + Shopify Integration
      • Overall Flow
      • Product Set Up: "Add-ons"
      • Line Item Properties
      • Shopify Cart
      • Order Processing
  • API
    • Environments
    • Image QueryString API
      • Image Transforms
      • Image Filters
      • Image Encoding
    • Rendering
    • WebToPrint (W2P)
    • Assets
    • Rate Limiting
  • Marketing
    • Share
  • General
    • Glossary
Powered by GitBook
On this page
  • Usage
  • Examples
  • Other Examples

Was this helpful?

  1. API

Image QueryString API

Spectrum allows for QueryString parameters that may be added to rendering and image routes to control the size and other graphic manipulations to output images.

PreviousEnvironmentsNextImage Transforms

Last updated 2 months ago

Was this helpful?

The commands available are documented into the following categories:

Usage

/api/assets/generated/recipeSet/readable/L83NJTB7/east?width=400&height=400

Note: the order of QueryString parameters does not affect output. The are evaluated in the most efficient operations regardless of order.

Examples

​

Other Examples

  • width=100&height=100&mode=max&scale=down ensures the image is downscaled to 100x100 or less, but does not upscale the image if it is already smaller than that. Aspect ratio is maintained.

  • width=200&height=200&mode=max&scale=both ensures the image is downscaled or upscaled to fit within 200x200, maintaining aspect ratio.

  • width=200&height=200&mode=pad&scale=both ensures the image is downscaled or upscaled to fit within 200x200, maintaining aspect ratio, then is padded to make the result always 200x200.

  • width=300&height=300&mode=crop&scale=both ensures the image is downscaled or upscaled to fit around 300x300, then minimally cropped to meet the aspect ratio. scale=both ensures the image is upscaled if smaller so the result is always 300x300.

https://api.spectrumcustomizer.com/api/assets/generated/recipeSet/readable/L83NJTB7/east?width=150&height=150&bgcolor=CCCCCC
Image Transforms
Image Filters
Image Encoding
https://api.spectrumcustomizer.com/api/assets/generated/recipeSet/readable/L83NJTB7/east?width=250&height=250
?width=250&height=250
?width=150&height=150&bgcolor=CCCCCC