API Overview
The Breeze Cloud APIs allow you to integrate third party applications in to your experience. This could allow for sending media captured to 3rd party storage solutions like Amazon S3, Dropbox or, to other API’s for further processing. Media (images, videos etc) that have been processed by a 3rd party application, can be sent back to a Breeze Cloud Microsite for client delivery. Additionally, microsite descriptions, footers and background images can be updated via the API allowing you to create highly customized microsites based on data collected at the booth.
API Key
You will need your API Key, which you can generate from API Setting in your account.
https://cloud.breezesoftware.com/settings/api
API Documentation
Details of each API can be found on our dedicated API Documentation website. If you need assistance with APIs please contact us to discuss.
https://apidocs.breezesoftware.com
Available APIs
If you have a request for an API that is not available, please contact us to discuss. Please see our API Documentation website for full details of each API.
| GET | Session Data |
| GET | Find Events |
| GET | Find Media |
| POST | Create Event |
| POST | Upload Media |
| POST | Upload Media By a Link |
| PUT | Change Event Visibility |
| PUT | Change Session Visibility |
| PUT | Update Session |
| POST | Send Status URL Command to Device beta |
| GET | List Devices beta |
Post Processing v API
The Post Processing feature in RemotePro & Breeze Booth allow you to process a photo, as part of the photo booth session. In this scenario, the image captured, gets sent as a POST request, and Breeze waits (typically up to 60 seconds) for a response from the server with the final image. This image is then used to finalise the session to make the print layout, GIFs etc. It’s designed so users get to see the result whilst waiting at the photo booth.
The Breeze Cloud APIs are more expansive, and allow for more than just image processing. The API’s are not run as part of the actual photo booth session, but rather outside the session. This allows you to do things such as:
- Create events
- Update microsite descriptions, footers
- Add 3rd party media to the microsite
- 3rd Party Process photos and videos and return to microsite
- Capture media, and process later
- Hide / Unhide sessions and events
This opens up a lot more options for how you can use Breeze and how it interacts with 3rd party applications and media created elsewhere. You could use Breeze as a way to simply capture the media, process it elsewhere, but return it back to a known microsite URL. You could run survey data via ChatGPT and update a specific microsite description with the results (allowing for highly personalised microsites). You could build an automated event setup system that integrates with your booking system.