Quickstart

Base URL: https://api.kiosk-x.ai

1. Pick a credential

The sandbox ships with ready-to-use credentials (all data is mock):

Credential	Value	Access
API key (Superior Vending Co.)	`vtm_e08725ea09876af65f431c6a3742d7c0`	own machines, read+write
API key (Akash)	`vtm_66eef98855b77f6d9a8f4fb5aaa70da5`	own machines, read+write
API key (admin)	`vtm_kioskx_admin_5f2a9c1d8e7b4a3f`	all operators + `accounts:admin`

OAuth client credentials are listed in Authentication.

2. First request

curl https://api.kiosk-x.ai/api/v1/machines \
  -H "X-API-Key: vtm_e08725ea09876af65f431c6a3742d7c0"

{
  "code": 200,
  "message": "success",
  "data": {
    "page": 1, "size": 20, "total": 2,
    "records": [
      {
        "id": "8b7df143d91c716ecfa5fc1730022f6b",
        "machineNo": "866903013700011",
        "name": "Ryan Test",
        "status": "online",
        "lastSeen": "2026-08-10T11:49:00.000+0000",
        "location": "Warehouse A",
        "lat": "40.7128", "lng": "-74.0060",
        "notes": null,
        "expireDate": "2027-08-10T12:00:00.000+0000",
        "rentState": 1
      }
    ]
  }
}

3. Explore

Interactive Swagger UI — click Authorize, paste an API key
Check inventory: GET /api/v1/inventory/machines/866903013700011
Query sales: GET /api/v1/orders/summary
Read the P&L: GET /api/v1/pnl
Verify everything is live: GET /sandbox/readiness (no auth needed)

The money jobs — host venues, receiving stock, tax, the P&L — are in the operator guide. Console onboarding is /playbook.