Imaging Endpoint | Documentation | CanvasPop Photo Printing API

API Endpoints

Pop-up Store Base URL

https://store.canvaspop.com

All Push API endpoints return a JSON response, with an HTTP response code of 200 under success conditions, and 500 under error conditions.

Push API Endpoints
Preview Image	Endpoint for sending a low resolution, preview image before using the Print Image endpoint.
Print Image	Endpoint for sending a high resolution, print image following using the Preview Image endpoint.
Single Image	Endpoint for sending single print image.
Pull API Endpoints
Pull Image	Endpoint for pulling an image from a publicly accessible URL.
Loader Endpoint
Loader	Endpoint for loading a PopUp Store cart using an image token received from either a preview or single image handshake. The printWidth and printHeight parameters are required when opening Pop-up Store after completing a preview image handshake. When using a single image handshake, these are not required.

Push API Endpoints

Preview Image

POST /api/push/preview

Endpoint for sending a low resolution, preview image before using the Print Image endpoint.

Parameters

Name	Required	Type	Description
`image`	Required	file	The preview image, included as a file in a multipart/form-data HTTP POST.

Response

{"image_token":"7c50e8fd87644ba12654845d4b7bc6746f7c64a793fc08da1946d7c188809999","message":"Image uploaded successfully"}

Print Image

POST /api/push/print

Endpoint for sending a high resolution, print image following using the Preview Image endpoint.

Parameters

Name	Required	Type	Description
`image`	Required	file	The preview image, included as a file in a multipart/form-data HTTP POST.
`token`	Required	string	The preview image token returned in preview image handshake.

Response

{"message":"Image uploaded successfully"}

Single Image

POST /api/push/image

Endpoint for sending single print image.

Parameters

Name	Required	Type	Description
`image`	Required	file	The preview image, included as a file in a multipart/form-data HTTP POST.

Response

{"image_token":"7c50e8fd87644ba12654845d4b7bc6746f7c64a793fc08da1946d7c188809999","message":"Image uploaded successfully"}

Pull API Endpoints

Pull Image

GET /api/pull

Endpoint for pulling an image from a publicly accessible URL.

Parameters

Name	Required	Type	Description
`image_url`	Required	string	The URL of the image you wish to load a PopUp Store cart with.
`access_key`	Required	string	Your PopUp Store Access Key

Loader Endpoint

Loader

GET /loader/token/printWidth/printHeight?reference_id=REFERENCE_ID

Endpoint for loading a PopUp Store cart using an image token received from either a preview or single image handshake. The printWidth and printHeight parameters are required when opening Pop-up Store after completing a preview image handshake. When using a single image handshake, these are not required.

Parameters

Name	Required	Type	Description
`token`	Required	string	The image_token from a preview/single image handshake.
`printWidth`	Optional	int	The width of the high resolution, print image, in pixels.
`printHeight`	Optional	int	The height of the high resolution, print image, in pixels.
`reference_id`	Optional	string	An optional reference_id string (256 characters maximum) that may be provided that will be linked to orders loaded through this endpoint.