{"info":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","description":"

You can use the dslrBooth API to communicate and send commands to dslrBooth. dslrBooth automatically generates a random password that you will have to specify in the URL for each command you send as a password GET parameter.

\n

The API allows you to run the following commands:

\n\n

Don’t forget to append and use the password parameter with the password that dslrBooth generates for your booth.

\n

Let us know if you need the API to do something else as well.

\n

Requirements

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5516194","collectionId":"759de597-9f1b-4bdb-998a-0c6654e7332a","publishedId":"UVRBnmJ5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4f9bc2"},"publishDate":"2022-01-12T22:58:22.000Z"},"item":[{"name":"Start a Session","item":[{"name":"Start a Session","id":"6f703686-0ec0-493e-82fd-e4aa6826fde0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/start?mode=print","description":"

Use these method to start a session with a specific booth mode (print/gif/boomerang/video). dslrBooth must be on the start screen or you'll get an error back.

\n

The API won’t be able to start a session that isn’t enabled in the booth configuration.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}},"urlObject":{"protocol":"http","port":"{{port}}","path":["api","start"],"host":["{{baseUrl}}"],"query":[{"key":"mode","value":"print"}],"variable":[]}},"response":[{"id":"4ef10b5d-0254-4915-a211-aea04d0bbc67","name":"Print session","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/start?mode=print","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","start"],"query":[{"key":"mode","value":"print"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"9"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"start?mode=print\",\n \"IsSuccessful\": true,\n \"ErrorMessage\": \"\"\n}"},{"id":"ba217ecf-dee9-4ecb-8d8c-de358fe4e8b2","name":"GIF session","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/start?mode=gif","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","start"],"query":[{"key":"mode","value":"gif"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"12"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"start?mode=gif\",\n \"IsSuccessful\": true,\n \"ErrorMessage\": \"\"\n}"},{"id":"deaa0707-ca1e-4d9c-9b5e-2f0be4f0635c","name":"Video session","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/start?mode=video","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","start"],"query":[{"key":"mode","value":"video"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"13"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"start?mode=video\",\n \"IsSuccessful\": true,\n \"ErrorMessage\": \"\"\n}"},{"id":"3c4f6129-a1b0-4715-ba39-439dd675ab97","name":"Boomerang session","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/start/boomerang"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"17"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"start?mode=boomerang\",\n \"IsSuccessful\": true,\n \"ErrorMessage\": \"\"\n}"},{"id":"2e954a25-96d7-4c0b-a18a-ff301335415a","name":"Error - Not on Start Screen","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/start?mode=print","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","start"],"query":[{"key":"mode","value":"print"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"10"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"134"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"start?mode=print\",\n \"IsSuccessful\": false,\n \"ErrorMessage\": \"The booth is not on the start screen to start a session\"\n}"},{"id":"d4f47ef4-a842-49bf-a0cd-9df0d564a220","name":"Error - Booth mode is not enabled","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/start?mode=print","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","start"],"query":[{"key":"mode","value":"print"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ApiVersion\": 1,\r\n \"Command\": \"start?mode=print\",\r\n \"IsSuccessful\": false,\r\n \"ErrorMessage\": \"Print is not an enabled booth mode. Enable in app settings.\"\r\n}"},{"id":"01a92a9c-d139-45a9-b22f-4668668d3a91","name":"Error - The booth is locked","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/start?mode=print","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","start"],"query":[{"key":"mode","value":"print"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ApiVersion\": 1,\r\n \"Command\": \"start?mode=print\",\r\n \"IsSuccessful\": false,\r\n \"ErrorMessage\": \"The booth is locked\"\r\n}"}],"_postman_id":"6f703686-0ec0-493e-82fd-e4aa6826fde0"}],"id":"d24d7de0-3fb2-42ed-9088-62ed7e96bb47","_postman_id":"d24d7de0-3fb2-42ed-9088-62ed7e96bb47","description":"","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}}},{"name":"Share","item":[{"name":"Print","id":"6a0192ed-8d72-4952-9279-6827f9320779","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/print?count=1","description":"

To print a specific number of copies of the last picture, set the count parameter with the number of copies you want to reprint

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}},"urlObject":{"protocol":"http","port":"{{port}}","path":["api","print"],"host":["{{baseUrl}}"],"query":[{"key":"count","value":"1"}],"variable":[]}},"response":[{"id":"0295cadc-bdc4-47e5-aaf3-e4bb3fbe6fbe","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/print?count=1","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","print"],"query":[{"key":"count","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"2"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"print\",\n \"IsSuccessful\": true,\n \"ErrorMessage\": \"\"\n}"},{"id":"b67bb8a5-c66c-4732-a7b2-2f55e8933e9f","name":"Error - Last Session was not a photo session","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/print?count=1","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","print"],"query":[{"key":"count","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"18"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"130"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"print\",\n \"IsSuccessful\": false,\n \"ErrorMessage\": \"Cannot print last session as it was not a photo session\"\n}"},{"id":"a3901fb5-03b3-4026-aaaf-9a8fcf0c7dac","name":"Error - No previous session since app was started","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/print?count=1","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","print"],"query":[{"key":"count","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"1"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"101"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"print\",\n \"IsSuccessful\": false,\n \"ErrorMessage\": \"There is no image to reprint\"\n}"}],"_postman_id":"6a0192ed-8d72-4952-9279-6827f9320779"},{"name":"Share over Email","id":"b82a4b46-9c72-4031-b1bc-bcd7c9fcf43d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/share/email?email=test@test.com","description":"

Share the last session by emailing it to a specific email address.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}},"urlObject":{"protocol":"http","port":"{{port}}","path":["api","share","email"],"host":["{{baseUrl}}"],"query":[{"key":"email","value":"test@test.com"}],"variable":[]}},"response":[{"id":"98a5d84e-0144-40a8-be93-7677365d9fab","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/share/email?email=me@me.com","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","share","email"],"query":[{"key":"email","value":"me@me.com"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ApiVersion\": 1,\r\n \"Command\": \"share/email\",\r\n \"IsSuccessful\": true,\r\n \"ErrorMessage\": \"\"\r\n}"},{"id":"aacffb5d-6f5b-4ecd-8afd-73f55a07ccc4","name":"Error - No image or video to share","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/share/email?email=me@me.com","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","share","email"],"query":[{"key":"email","value":"me@me.com"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ApiVersion\": 1,\r\n \"Command\": \"share/email\",\r\n \"IsSuccessful\": false,\r\n \"ErrorMessage\": \"There is no previous session with an image or video to share since the app started\"\r\n}"}],"_postman_id":"b82a4b46-9c72-4031-b1bc-bcd7c9fcf43d"},{"name":"Share over SMS","id":"71084804-c6c4-429a-87ea-7a7b24d4cbc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/share/sms?phone=5555555555","description":"

Share the last session by sending an sms message to a specific phone number. Phone number should only contain digits and no formatting.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}},"urlObject":{"protocol":"http","port":"{{port}}","path":["api","share","sms"],"host":["{{baseUrl}}"],"query":[{"key":"phone","value":"5555555555"}],"variable":[]}},"response":[{"id":"f09ad6da-f998-4e00-b4f3-cbe923706721","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/share/sms?phone=5555555555","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","share","sms"],"query":[{"key":"phone","value":"5555555555"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ApiVersion\": 1,\r\n \"Command\": \"share/sms\",\r\n \"IsSuccessful\": true,\r\n \"ErrorMessage\": \"\"\r\n}"},{"id":"4da6b8f1-7907-4766-aa7f-39126c640c53","name":"Error - No image or video to share","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"http://{{baseUrl}}:{{port}}/api/share/sms?phone=5555555555","protocol":"http","host":["{{baseUrl}}"],"port":"{{port}}","path":["api","share","sms"],"query":[{"key":"phone","value":"5555555555"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"ApiVersion\": 1,\r\n \"Command\": \"share/sms\",\r\n \"IsSuccessful\": false,\r\n \"ErrorMessage\": \"There is no previous session with an image or video to share since the app started\"\r\n}"}],"_postman_id":"71084804-c6c4-429a-87ea-7a7b24d4cbc7"}],"id":"c920d82f-ec79-49c2-a9a0-99f518355588","_postman_id":"c920d82f-ec79-49c2-a9a0-99f518355588","description":"","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}}},{"name":"Lock Screen","item":[{"name":"Show Lockscreen","id":"1fa4705b-4dcd-4d16-af83-f53a9805b5ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/lockscreen/show","description":"

Show the lock screen with preset message.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}},"urlObject":{"protocol":"http","port":"{{port}}","path":["api","lockscreen","show"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"52655dfc-6653-42de-8e48-938d60c1f824","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/show/lockscreen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"7"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"lockscreen/show\",\n \"IsSuccessful\": true,\n \"ErrorMessage\": \"\"\n}"},{"id":"a38bbf62-c039-46e5-b3d3-5a80f77641a2","name":"Error - No PIN configured","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/lockscreen/show"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"6"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"146"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"lockscreen/show\",\n \"IsSuccessful\": false,\n \"ErrorMessage\": \"The Lock Screen requires a security PIN configured in the app settings\"\n}"}],"_postman_id":"1fa4705b-4dcd-4d16-af83-f53a9805b5ee"},{"name":"Exit Lockscreen","id":"aa117c82-6670-4d54-b3ce-d172e3aad3b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/lockscreen/hide","description":"

Exit the lock screen

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}},"urlObject":{"protocol":"http","port":"{{port}}","path":["api","lockscreen","hide"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"62982035-9e80-40a0-8ff4-f556c29df1eb","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/lockscreen/exit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"8"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"lockscreen/exit\",\n \"IsSuccessful\": true,\n \"ErrorMessage\": \"\"\n}"},{"id":"f781edbc-e444-4d6d-9cdb-75e74c8851bf","name":"Error - Lock screen was not showing","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{baseUrl}}:{{port}}/api/lockscreen/exit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Pipeline-Index","value":"9"},{"key":"X-Powered-By","value":"Griffin.Framework (http://github.com/jgauffin/griffin.framework)"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"}],"cookie":[],"responseTime":null,"body":"{\n \"ApiVersion\": 1,\n \"Command\": \"lockscreen/exit\",\n \"IsSuccessful\": false,\n \"ErrorMessage\": \"The booth is not showing the Lock Screen\"\n}"}],"_postman_id":"aa117c82-6670-4d54-b3ce-d172e3aad3b8"}],"id":"3849fc7f-3e90-47f8-9cd3-b6bd809b9537","description":"

Show and hide the dslrBooth lock screen which stops guests from using the app and displays a custom preset message.

\n

The lock screen requires a security PIN configured in the booth.

\n","_postman_id":"3849fc7f-3e90-47f8-9cd3-b6bd809b9537","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"759de597-9f1b-4bdb-998a-0c6654e7332a","id":"759de597-9f1b-4bdb-998a-0c6654e7332a","name":"dslrBooth for Windows API documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"value":"","key":""}},"event":[{"listen":"prerequest","script":{"id":"705c1421-666e-44e0-9808-e01e13515256","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"39fd7526-a2c2-4efd-8317-d89fee7ff32e","type":"text/javascript","exec":[""]}}]}