Snapsbrew Documentation - API Reference

Template
Template Layer
Screenshot
Snap
Layer

# Template

Lorem ipsum dolor sit amet consectetur adipisicing, elit. Amet aperiam odit nam quidem veniam, commodi ut perspiciatis deserunt voluptas quaerat earum repudiandae ipsam, voluptatibus magnam, cupiditate quisquam corrupti impedit eius!

{
  "title": "Template 1"
  "template_uuid": "141e8454-8aa1-420a-bd0b-18a85ba949a2",
  "layers": [
    {
      "layer": "review_poster",
      "available_modifications": {
        "image_url": "https://snapsbrew.com/crazy-doc-brown-jailed"
      }
    },
    {
      "layer": "review_title",
      "available_modifications": {
        "text": "The worst Time-Travel movie ever made"
      }
    },
    {
      "layer": "reviewer_handle",
      "available_modifications": {
        "text": "@grumpyTraveler"
      }
    }
  ]
}

title: The title of the template.
template_uuid (read only): The UUID of the template. This field is the one you'll need when creating a Snap.
layers (read only): The layers field provides the user a list with all the layers that compose the given template.

Checkout the Template Layer reference for more information about this object.

# Template Layer

{
  "layer": "review_poster"
  "available_modifications": {
    "image_url": "https://snapsbrew.com/crazy-doc-brown-jailed"
  },
}

layer (read only): The id of the layer. This is the field you'll need to pass when creating a Snap
available_modifications (read only): An object with all the available modifications (duh) for the given layer with their default value.

# Screenshot

{
  "uuid": "73824855-47b0-421d-be7d-e238ebfbfe29",
  "url": "https://legendsverse.com",
  "image_url": "https://snapsbrew.com/storage/43/conversions/media-librarywE0C8F-image.jpg",
  "width": 1330,
  "height": 780,
  "created_at": "1985-10-15:18:38.000000Z"
}

uuid (read only): The uuid of the screenshot.
url: The url to which the screenshot was taken.
image_url (read only): The url where the screenshot is stored.
width: The width in pixels of the screenshot.
height: The height in pixels of the screenshot.
created_at (read only): The date and time when the screenshot was taken.

# Snap

{
  "uuid": "73824855-47b0-421d-be7d-e238ebfbfe29",
  "template_uuid": "141e8454-8aa1-420a-bd0b-18a85ba949a2",
  "type": "image",
  "layers": [
    {
      "layer": "review_poster",
      "modifications": {
        "image_url": "https://snapsbrew.com/crazy-doc-brown-jailed"
      }
    },
    {
      "layer": "review_title",
      "modifications": {
        "text": "The worst Time-Travel movie ever made"
      }
    },
    {
      "layer": "reviewer_handle",
      "modifications": {
        "text": "@grumpyTraveler"  
      }
    }
  ],
  "media_url": "https://snapsbrew.com/storage/43/conversions/media-librarywE0C8F-image.jpg",
  "created_at": "1985-10-15:18:38.000000Z"
}

uuid (read only): The uuid of the snap.
template_uuid (read only): The uuid of the template this snap from which this snap was taken.
type: The type of the snap: image, pdf.
media_url (read only): The url where the snap is stored.
layers: An array of Layer objects that overwrites the layers of the template selected.

Checkout the Layer reference for more information about this object.
created_at (read only): The date and time when the screenshot was taken.

# Layer

{
  "layer": "reviewer_name",
  "modifications": {
    "text": "@GrumpyTraveler"
  }
}

{
  "layer": "review_poster",
  "modifications": {
    "image_url": "https://snapsbrew.com/crazy-doc-brown-jailed"
  }
}

layer: The id of the layer. This is the field you'll need to pass when creating a Snap
modifications: Modifications is an array of objects. These objects can contain any of the following key and value pairs.
image_url: The image_url key will only work for layers that have image_url as an available_modification
text: The text key will only work for layers that have text as an available_modification

Get Started

REST API