Developer Reference & REST APIs

Alpha QR Developer Documentation

The Alpha QR platform exposes clean, RESTful JSON endpoints. Integrate dynamic QR code generation, scan webhooks, and analytics into your external systems.

Standard Authentication Headers:

Endpoints requiring user session authentication validate your active NextAuth cookie or API token. JSON responses include strict status payloads and ISO timestamps.

Dynamic QR Engine Endpoints

Create, list, update, redirect, scan-track and reclaim dynamic QR codes.

Method	Endpoint Route	Description	Auth
POST	/api/qr/create	Create a new dynamic QR code	User Session
GET	/api/qr/list	List all QR codes for the signed-in user	User Session
GET	/api/qr/[id]	Resolve a QR code to its live destination	Public
PUT	/api/qr/[id]	Update the content and design of a QR code	User Session
DELETE	/api/qr/[id]	Delete (or park) a QR code	User Session
GET	/api/qr/[id]/details	Fetch a single QR code's full details	User Session
GET	/api/qr/[id]/scan	Record a scan and return the redirect payload	Public
POST	/api/qr/[id]/transfer	Request ownership transfer of a QR code	User Session
POST	/api/qr/reclaim	Reclaim a parked QR code from a scanned image	User Session

Scan Telemetry & Analytics

Real-time edge scan analytics, device distribution, and daily counts.

Method	Endpoint Route	Description	Auth
GET	/api/analytics/[id]	Return scan counts, daily series, locations and devices	User Session

Comments & Social Interaction

Visitor feedback and interactive engagement collected on scan landing cards.

Method	Endpoint Route	Description	Auth
GET	/api/comments	List comments for the signed-in user's QR codes	User Session
POST	/api/comments	Create a new comment on a QR scan page	User Session
PATCH	/api/comments/[id]	Update a comment or toggle its state	User Session
DELETE	/api/comments/[id]	Remove a comment	User Session

Billing & Razorpay Webhooks

1-time UPI order generation, client signature verification, and automated webhooks.

Method	Endpoint Route	Description	Auth
POST	/api/payment/create-order	Create a Razorpay order for a plan	User Session
POST	/api/payment/verify	Verify a completed payment and upgrade the plan	User Session
POST	/api/payment/verify-redirect	Server-side verification used by redirect flows	User Session
POST	/api/webhook/razorpay	Razorpay webhook for payment events	Public

Ownership Transfers

Secure QR code ownership transfer protocol with 10-digit authorization keys.

Method	Endpoint Route	Description	Auth
POST	/api/transfer/request	Request transfer of a QR code to another user	User Session
POST	/api/transfer/accept	Accept an incoming transfer request	User Session
POST	/api/transfer/reject	Reject an incoming transfer request	User Session
GET	/api/transfer/history	List transfer history for the signed-in user	User Session

User Profile & Assets

Account preferences, high-res logo uploads, and GDPR/DPDP purge endpoints.

Method	Endpoint Route	Description	Auth
GET	/api/user/me	Fetch the signed-in user's profile and usage	User Session
DELETE	/api/user/me	Permanently delete the signed-in user's data	User Session
POST	/api/upload/logo	Upload a logo image for QR branding	User Session
GET	/api/waitlist	Check waitlist status	Public
POST	/api/waitlist	Join the waitlist	Public