post
https://production-api.shoutaboutus.com/api/v1/qr-codes/abc-unique-code/scan
Public, unauthenticated endpoint hit when an end customer scans a QR code. Resolves the unique_code to a QrCode (falling back to a QrCodeTemplate, then its parent QrCode), records a scan-history row (IP, user-agent, referer, optional geo/device fields), bumps last_scanned_at, and returns the destination URL.
Auth: Public — no authentication required. Registered outside the authenticated group, rate-limited to 30 requests per minute per IP. Anyone with the code may call it.
Rate limit: 30 requests/min.
Request
- Path:
unique_code(string, required) — unique code of a QrCode or QrCodeTemplate. In the collection example this is the literalabc-unique-code. - Body (untyped
Request, all optional; The endpoint stores only included fields):
| Field | Type | Required | Notes |
|---|---|---|---|
| latitude | number | optional | stored only if both latitude and longitude are present |
| longitude | number | optional | stored only if both latitude and longitude are present |
| device_type | string | optional | — |
| browser | string | optional | — |
| os | string | optional | — |
| metadata | object | optional | arbitrary JSON |
Response — { data. } envelope wrapping an array.
data.data.destination_url(string) — resolved viagetDestinationUrl.data.data.qr_code_name(string)data.data.scan_count(int) — total scan-history rows for the QR code.data.data.last_scanned_at(datetime, nullable)data.message(string) —"QR code scanned successfully".
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
