Intro
Welcome to MockupsJar! You can use our API to access MockupsJar endpoints, which can create, access and render mockups.
Overview
Overview
Authentication
The API is using API TOKENS to authenticate requests. You can view and manage your API tokens in the MockupsJar Profile. https://mockupsjar.com/profile BASE API ADDRESS: https://api.mockupsjar.com An easy way to test if your token is working properly is using the following script:
Get Info
To retrieve information relate to a mockup you can use the /mockups/getinfo endpoint. GET /mockups/getinfo/<mockup-name> Valid response: 200 Ok { "status": "success", "data": { "slug": "swiasi-android-s5-top", "name": "Samsung Galaxy S5 Top View", "fields": [ { "id": 2, "width": 161, "height": 287 } ] } } Invalid response: 500 Exception
Get List
To retrieve all the mockups that are published you can use the /mockups/list endpoint. GET /mockups/list Valid response: 200 Ok { "status": "success", "data": [ { "slug": "ripped-torn-paper-1", "name": "Ripped Torn Paper 1", "width": 640, "height": 427, "previewURL": "https://mockupsjar-production.
Render
To render a mockup using an uploaded image or website url you can use the /mockups/render endpoint. POST /mockups/render/<mockup-name> Parameters: zoomLevel: set the zoom level for the mockup (default: 1 => 640px) (range: 0.