Product Images
Using WebGL SSR APIs, product images of customized products could be generated on the fly just by requesting them.
Request images using a short URL​
Useful for production sites, a product image could be requested just by defining the recipe Id and the desired view.
URL Example​
https://cdn-webgl-ssr-prod.fluidconfigure.com/snapshot/recipe/77429274/image/Front.jpg
URL Components​
| Component | Required | Value | Notes |
|---|---|---|---|
| Host | Yes | https://cdn-webgl-ssr-prod.fluidconfigure.com | |
| Product Reference | Yes | /recipe/{recipeId} | |
| Requested Resource | Yes | /image | |
| Selected View | Yes | /{viewName} | viewName could be the name of any supported view |
| Image Format | Yes | .{format} | The supported formats are jpg, jpeg and png |
Supported Query Parameters​
| Parameter | Required | Value | Default Value | Notes |
|---|---|---|---|---|
| Image Scaling | No | scale={number} | 1 | The scaling size could go from 0.01 to 5. Exceeding the 2000px width or height could lead to errors or bad performance |
| Image Width | No | width={number} | Product width | Exceeding the 2000px width could lead to errors or bad performance |
| Image Height | No | height={number} | Product height | Exceeding the 2000px height could lead to errors or bad performance |
Request images using a verbose URL​
Useful for development purposes or an advanced use, a product image could be requested by defining, and in some cases overwriting, key properties of a product.
URL Example​
URL Components​
| Component | Required | Value | Notes |
|---|---|---|---|
| Host | Yes | https://cdn-webgl-ssr-prod.fluidconfigure.com | |
| Requested Resource | Yes | /snapshot |
Supported Query Parameters​
| Parameter | Required | Value | Default Value | Notes |
|---|---|---|---|---|
| Customer Reference | Yes | customer={customerId} | ||
| Product Reference | Yes | product={productId} | ||
| Recipe Reference | Yes | recipe={recipeId} | ||
| Selected View | Yes | camera={viewName} | viewName could be the name of any supported view | |
| Product Workflow | No | workflow={workflowName} | prod | |
| Product Environment | No | environment={environmentName} | prod | |
| WebGL Environment | No | webglEnv={webglEnv} | prod | |
| Image Format | No | format={formatExtension} | jpg | The supported formats are jpg, jpeg and png |
| Image Scaling | No | scale={number} | 1 | The scaling size could go from 0.01 to 5. Exceeding the 2000px width or height could lead to errors |
| Image Width | No | width={number} | Product width | Exceeding the 2000px width could lead to errors or bad performance |
| Image Height | No | height={number} | Product height | Exceeding the 2000px height could lead to errors or bad performance |
| Recipe Overrides | No | overrides={string} | Allow overrides in CAs and AVs passing them in the url with the following formats: ?overrides=107612:206625,107613:206782,110546:209249,110549:JJ ?overrides=color_palette:206625,sleeve_color:206782,110546:209249,110549:JJ allowing the following combinations: caId/caVendorId/alias:avId/avVendorId/text,... with multiple permutations: caId:avId,caId:avVendorId,alias:text&... | |
| Hooks data | No | hooks={string} | The hooks parameter value will be shared with the hooks functions as parameter |