Generate Single Render

POST

 https://app.dynamicmockups.com/api/v1/renders/

NOTE: The limit for requests per minute is set at 300. Feel free to reach out to us if you need more.

NOTE: Max size per asset file in each smart object is 20MB.

Security -> API Authentication

This API implementation uses API KEY as an authentication method.

• Name: X-API-KEY
• In: header

Request Parameters

Name	Located in	Description	Required	Type
mockup_uuid	URL	Public identifier of the mockup	Required	string
export_label	Body	Your internal identifier that helps you to identify and link rendered image	Optional	string
export_options[image_format]	Body	Rendered image format	Optional	jpg | png | webp
export_options[image_size]	Body	Rendered image size in pixels	Optional	int
smart_objects[0][uuid]	Body	Public identifier of smart object	Required	string
smart_objects[0][color]	Body	Hexadecimal color code that will be applied over entire smart object	Optional	string
smart_objects[0][asset][url]	Body	Design asset file via URL	Optional	string
smart_objects[0][asset][file]	Body	Design asset file (max size 20MB)	Optional	file
smart_objects[0][asset][fit]	Body	Design asset 'fit' relative to print area set via Editor. Size and position of print area is controlled via Editor. [asset][size] and [asset][position] can't be used alogside 'fit'.	Optional	contain | cover | stretch
smart_objects[0][asset][size][width]	Body	Desired asset width	Optional	int
smart_objects[0][asset][size][height]	Body	Desired asset height	Optional	int
smart_objects[0][asset][position][top]	Body	Top asset position relative to smart object's top-left corner	Optional	int
smart_objects[0][asset][position][left]	Body	Left asset position relative to smart object's top-left corner	Optional	int
smart_objects[0][asset][rotate]	Body	Rotation angle in degrees	Optional	int

Request example with posman body data

mockup_uuid: "6308f2f7-80eb-42ab-a109-08a33e6dcc2d"
export_label: 1
export_options[image_format]: "webp"
export_options[image_size]: 512
smart_objects[0][uuid]: "22ec3dec-4df8-4643-8c68-01b72fa506f5"
smart_objects[0][asset][url]: "https://images.pexels.com/photos/3225517/pexels-photo-3225517.jpeg"
smart_objects[0][asset][fit]: "contain"
smart_objects[0][color]: "#ffd667"

Request example with FormData

const formData = new FormData();

formData.append("mockup_uuid", "6308f2f7-80eb-42ab-a109-08a33e6dcc2d");
formData.append("export_label", "1");
formData.append("export_options[image_format]", "webp");
formData.append("export_options[image_size]", "512");
formData.append(
  "smart_objects[0][uuid]",
  "22ec3dec-4df8-4643-8c68-01b72fa506f5"
);
formData.append("smart_objects[0][asset][file]", "MY FILE");
formData.append("smart_objects[0][asset][position][top]", "71");
formData.append("smart_objects[0][asset][position][left]", "198");
formData.append("smart_objects[0][asset][size][width]", "178");
formData.append("smart_objects[0][asset][size][height]", "198");
formData.append("smart_objects[0][color]", "#ffd667");

Request example with json structured data

{
  "mockup_uuid": "6308f2f7-80eb-42ab-a109-08a33e6dcc2d",
  "export_label": "1",
  "export_options": {
    "image_format": "webp",
    "image_size": "512"
  },
  "smart_objects": [
    {
      "uuid": "22ec3dec-4df8-4643-8c68-01b72fa506f5",
      "color": "#ffd667",
      "asset": {
        "url": "https://images.pexels.com/photos/3225517/pexels-photo-3225517.jpeg",
        "position": {
          "top": "71",
          "left": "198"
        },
        "size": {
          "width": "178",
          "height": "198"
        },
      }
    }
  ]
}

Response

Code	Description
200	Return single render
401	Unauthorized.
404	Not Found.

Example Usage

Javascript

make-renders.js

var headers = new Headers();
headers.append("X-API-KEY", "API_KEY");
headers.append("Accept", "application/json");

var requestOptions = {
  method: "GET",
  headers: headers,
};

fetch("https://app.dynamicmockups.com/api/v1/renders/", requestOptions)
  .then((response) => response.json())
  .then((result) => console.log(result))
  .catch((error) => console.log("error", error));

PHP

make-renders.php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://app.dynamicmockups.com/api/v1/renders/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array(
    'X-API-KEY: API_KEY',
    'Accept: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Python

make-renders.py

import requests

url = "https://app.dynamicmockups.com/api/v1/renders/"

headers = {
  'X-API-KEY': 'API_KEY',
  'Accept': 'application/json'
}

response = requests.request("GET", url, headers=headers)

print(response.json)

Axios

make-renders.js

var axios = require("axios");

var config = {
  method: "get",
  url: "https://app.dynamicmockups.com/api/v1/renders/",
  headers: {
    "X-API-KEY": "API_KEY",
    Accept: "application/json",
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

Dart

make-renders.dart

var headers = {
  'X-API-KEY': 'API_KEY',
  'Accept': 'application/json'
};

var request = http.Request('GET', Uri.parse('https://app.dynamicmockups.com/api/v1/renders/'));

request.headers.addAll(headers);

http.StreamedResponse response = await request.send();

if (response.statusCode == 200) {
  print(await response.stream.bytesToString());
} else {
  print(response.reasonPhrase);
}

jQuery

make-renders.js

var settings = {
  url: "https://app.dynamicmockups.com/api/v1/renders/",
  method: "GET",
  headers: {
    "X-API-KEY": "API_KEY",
    Accept: "application/json",
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Go

make-renders.go

url:="https://app.dynamicmockups.com/api/v1/renders/"

client := &http.Client{}
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "API_KEY")
req.Header.Add("Accept", "application/json")
res, _ := client.Do(req)
defer res.Body.Close()
bytes ,err := ioutil.ReadAll(res.Body)
if err != nil {
  fmt.Println(err.Error())
}
fmt.Println(string(bytes))

Example Success Response

{
  "data": {
    "export_label": "1",
    "export_path": "https://app-dynamicmockups-production.s3.eu-central-1.amazonaws.com/11038/mockup_variation_1979_export.png"
  },
  "success": true,
  "message": "success"
}

Example Error Response

{
  "message": "Unauthorized."
}

Example Not Found Response

{
  "message": "Not found."
}