SimulArt Framing API

You can use our Framing API to create your own framing interface for any project. You will find detailed instructions, your API key, and demo code in your SimulArt account under Menu -> Framing API.

getFrame Endpoint

Generates an image and calculates it's price based on the variables in your request and the components of your account. This is normally used to display frame images and prices.

Example HTTP Request

https://youraccount.framing.studio/api/v7/getFrame?key=yourapikey&uniqueId=d5a38b7&m1=I100-50&p1=B61&pphf=2&aw=1000&iw=24&ih=16&imgUrl=https%3A%2F%2Fframing.studio%2Fimages%2Fim1.jpg

Example JSON Response

{"frameImg":"https:\/\/youraccount.framing.studio\/data\/cache\/010647814d661afe82dfc10dd1fabdb1.jpg","backingWidth":27.75,"backingHeight":19.75,"frameWidth":33.75,"frameHeight":25.75,"mapWidth":1000,"mapHeight":765,"angled":0,"subjectWidth":24,"subjectHeight":16,"matOpeningWidth":23.75,"matOpeningHeight":15.75,"moul1Price":"1265.37","moul1Vendor":"International","moul2Price":"0.00","moul2Vendor":"","moul3Price":"0.00","moul3Vendor":"","mat1Price":"17.74","mat1Vendor":"Bainbridge","mat2Price":"0.00","mat2Vendor":"","mat3Price":"0.00","mat3Vendor":"","glassPrice":"0.00","backingPrice":"0.00","mountPrice":"0.00","mountFramePrice":"0.00","printPrice":"0.00","variousPrice":"0.00","assemblyPrice":"0.00","royaltiesPrice":"0.00","totalBeforeDiscounts":"1283.11","total":"1283.11"}

getMats Endpoint

Lists the mats available in your account. This is normally used to load mat options in menus. 

Example HTTP Request

https://youraccount.framing.studio/api/v7/getMats?key=yourapikey&limit=5

Example JSON Response

{"1":{"code":"B12001","category":"BASICS","vendor":"Bainbridge","description":"Bainbridge Nougat 32' x 40'","priceCode":"1","maxWidth":"32.00","maxHeight":"40.00","image":"https:\/\/your account.framing.studio\/data\/matcolorscache\/B12001.jpg","thickness":"1.0","available_to":"1"},"2":{"code":"B12001L","category":"BASICS","vendor":"Bainbridge","description":"Bainbridge Nougat 40' x 60'","priceCode":"2","maxWidth":"40.00","maxHeight":"60.00","image":"https:\/\/your account.framing.studio\/data\/matcolorscache\/B12001L.jpg","thickness":"1.0","available_to":"1"},"3":{"code":"B12002","category":"BASICS","vendor":"Bainbridge","description":"Bainbridge Manila 32' x 40'","priceCode":"1","maxWidth":"32.00","maxHeight":"40.00","image":"https:\/\/your account.framing.studio\/data\/matcolorscache\/B12002.jpg","thickness":"1.0","available_to":"1"},"4":{"code":"B12003","category":"BASICS","vendor":"Bainbridge","description":"Bainbridge Brown 32' x 40'","priceCode":"1","maxWidth":"32.00","maxHeight":"40.00","image":"https:\/\/your account.framing.studio\/data\/matcolorscache\/B12003.jpg","thickness":"1.0","available_to":"1"},"5":{"code":"B12003L","category":"BASICS","vendor":"Bainbridge","description":"Bainbridge Brown 40' x 60'","priceCode":"2","maxWidth":"40.00","maxHeight":"60.00","image":"https:\/\/your account.framing.studio\/data\/matcolorscache\/B12003L.jpg","thickness":"1.0","available_to":"1"}}

getMouldings Endpoint

Lists the mouldings available in your account. This is normally used to load moulding options in menus.

Example HTTP Request

https://youraccount.framing.studio/api/v7/getMouldings?key=yourapikey&limit=5

Example JSON Response

{"1":{"code":"I0354-3029","category":"","vendor":"International","description":"1 1\/2 Mahogany Reverse Stairs","style":"regular","priceCode":"B","width":"1.5","height":"","rabbet":"","length":"","image":"https:\/\/youraccount.framing.studio\/data\/moulcache\/I0354-3029.jpg","available_to":"1"},"2":{"code":"I0354-3086","category":"","vendor":"International","description":"1 1\/2 Walnut Reverse Stairs","style":"regular","priceCode":"B","width":"1.5","height":"","rabbet":"","length":"","image":"https:\/\/your account.framing.studio\/data\/moulcache\/I0354-3086.jpg","available_to":"1"},"3":{"code":"I100-50","category":"","vendor":"International","description":"3 1\/8 Dk Walnut Panel \/ Dk Gold","style":"regular","priceCode":"E","width":"3.125","height":"","rabbet":"","length":"","image":"https:\/\/your account.framing.studio\/data\/moulcache\/I100-50.jpg","available_to":"1"},"4":{"code":"I1100-50","category":"","vendor":"International","description":"1x3 Black Tall Cap","style":"regular","priceCode":"C","width":"1","height":"","rabbet":"","length":"","image":"https:\/\/your account.framing.studio\/data\/moulcache\/I1100-50.jpg","available_to":"1"},"5":{"code":"I1100-55","category":"","vendor":"International","description":"1x3 Silver Tall Cap","style":"regular","priceCode":"D","width":"1","height":"","rabbet":"","length":"","image":"https:\/\/your account.framing.studio\/data\/moulcache\/I1100-55.jpg","available_to":"1"}}

getComponents Endpoint

Lists the components available in your account for a specific type. This is normally used to populate framing options select boxes.

Example HTTP Request

https://youraccount.framing.studio/api/v7/getComponents?key=yourkey&type=printing

Example JSON Response

[{"id":"19","code":"Photo Paper"},{"id":"24","code":"Canvas 2 Mirror Side"},{"id":"27","code":"Canvas 2 Black Side"},{"id":"28","code":"Metal"},{"id":"32","code":"Wood"},{"id":"33","code":"Canvas Image Stretched"},{"id":"42","code":"Unstretched Canvas"}]