5-minute quickstart
This guide walks through creating a YumKiosk owner account, pairing a simulated kiosk, inviting a test agent, and running your first order end to end. You won't need hardware — the platform ships with a built-in simulator at /simulator that emulates an Android tablet.
1. Create an owner account
Go to owner.yumkiosk.com and click Sign up. Enter your business name, email, and a password. You'll be dropped into the onboarding wizard, which covers four steps:
- Business info — legal name, address, phone, logo upload.
- Connect Stripe — click through to Stripe Connect onboarding. You can skip this during a trial.
- Seed a menu — upload a CSV or start with the sample burger menu.
- Pair a kiosk — generate a 6-digit pairing code.
Copy that pairing code. You'll use it in step 3.
2. Invite a test agent
From the owner panel, open Team → Agents and click Invite. Enter any email you own (a Gmail alias works fine). The agent will receive an invitation link pointing to agent.yumkiosk.com/accept-invite?token=.... Open that link in an incognito window, set a password, and you're logged in as an agent.
Toggle the status chip in the header to Available. You're now listening for incoming sessions.
3. Pair the simulator as a kiosk
Open a new tab and go to agent.yumkiosk.com/simulator. The simulator emulates an Android tablet in a 9-inch frame. Tap Pair kiosk, enter the 6-digit code from step 1, and hit Pair.
The simulator now shows the attract screen ("Tap to order"). Behind the scenes it's been registered as a real kiosk under your owner account — it will appear in Operations → Kiosks in the owner panel as simulator-<id>.
4. Start a session
On the simulator, tap Tap to order. This fires a POST /api/public/sessions/start request. Within a second, your agent browser tab should beep and show an incoming call card:
New session from Acme Burgers — Kiosk #simulator-42 [ Accept ] [ Dismiss ]
Click Accept. The agent dashboard splits into three panes:
- Left: live video of the kiosk (a camera feed of your browser).
- Middle: the menu, with categories and items.
- Right: the cart and checkout button.
5. Build an order
Click a couple of menu items on the agent dashboard. Each click appears instantly on the kiosk simulator — the cart is broadcast over WebSocket so both screens stay in sync. When the customer is happy, click Send to payment on the agent side. The kiosk shows a stubbed payment screen (Stripe test mode). Tap Pay now on the simulator, and the kiosk returns to its attract screen while the agent panel shows a green "Completed" card.
Done. You've just run a full YumKiosk session in five minutes. The rest of these docs go deeper into each surface — owners, agents, kiosks, and the APIs behind them.