Start here
This reference covers the booth API, for photo booth software that uploads to our galleries, and venue mode, for events run on a server at the venue. You call it with an API key we issue.
Base URL
Section titled “Base URL”| Environment | URL |
|---|---|
| Production | https://api.theloungebooth.com |
| Local | http://localhost:8787 |
GET /health answers {"ok":true,"venue":false} when the API is up, with
"venue":true from the venue server of a venue mode event. It needs no key and
doesn’t check the database.
Authentication
Section titled “Authentication”Send your API key as a bearer token on every call:
Authorization: Bearer tlb_…Ask us for a key. Each one belongs to one account on our side, starts tlb_,
and is shown only once when it is made. Every call is counted against it. A
missing or wrong key, or one since replaced or revoked, gets 401 with the plain
text body Unauthorized. A malformed Authorization header gets 400.
- Event: one booking, such as a product launch. It has a start and usually an end.
- Set: one booth station at an event. Most events have one; bigger ones have several.
- Session: one group in front of the booth. It starts
active(waiting in its set’s queue), then becomescompleted(photos published) orcancelled(left without photos). - Queue: a set’s active sessions, oldest first.
- Guest: one person in a session. The same person at another event is matched by email, then phone.
- Gallery: a completed session’s photos at
gallery.theloungebooth.com/<session id>. Completing a session publishes it and sends each guest the link.
Formats
Section titled “Formats”- Bodies are JSON, except the photo uploads, which are the raw image bytes.
- Ids are 14 letters and digits, such as
Mv6xC1kRp8Wdzn. Case matters. A session id is also its gallery link, so keep it out of logs you share. - Times are whole milliseconds since January 1, 1970 UTC, the number JavaScript’s
Date.now()gives.nullmeans not set. - Slugs such as
city-launchare the short names in our links. One route,GET /events/:eventSlug/sets/:setSlug, takes them to find a set; every other route takes ids. - Photos are JPEG or PNG.