HTTP REST API you can utilise to customize

Getting Started REST API provides endpoints you can use to retrieve data from you galleries. At the moment there are two endpoints - Show Gallery and Show Product Gallery.

Image resolution

We are using ImageMagic geometry to resize our images. 640x will resize image to 640px in width and it will keep proportions so height will be calculated based on image dimensions.

Manual / Photo Reviews Posts: Standard resolution is 640x and High resolution is 1080x
Instagram Posts: Standard & High resolution are the same - max. at 1080x1080px, Instagram API returns only one image size.

Errors API uses the following status and error codes:
200 OK
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
402 Payment Required -- Your have run out of image and/or video quota.
404 Not Found -- The specified request could not be found.
429 Too Many Requests -- Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Use this endpoint to get standard gallery data.

Data structure

  • total_pages - pagination info, you can request next page by adding ?page=2 at the end of endpoint URL
  • settings -JSON object contained settings for that gallery embed
  • items - array of gallery items

Item Object

  • data_type - image, video, carousel, text
  • source - instagram, custom
  • caption - if Instagram, caption from Instagram post, otherwise caption added when manually uploading or when customer added a photo
  • images - main images in 2 different resolutions
  • cover_images - optional cover image, used to show different image for the thumbnail, for eg. here is a PRESS gallery, showing one image as a thumbnail and then different one for the main popup image
  • videos - posts with videos will also have images hash with video screenshot

Item Link Object

  • link - URL for link
  • title - title / caption for link
  • image - URL to image for the link
  • prices - hash containing price info:  price_label, is_on_sale & sale_price
  • position_x - position for hotspots
  • position_y - position for hotspots
  • new_tab - open link in a new tab
  • shopify_product_id - Product Id (from Shopify)
Use this endpoint to get product gallery data. You'll need to know your Shop URL (:shop) and Product Handle (:product_handle)

This endpoint returns same data as Show Gallery
Contact Us