Developers
Built for developers too.
Build on top of selected MDXTORA services. This page explains how QRinst works under the hood, how the QR generation API works, how to install the icon kit Faviqo generates, and the practices we recommend when you integrate QR codes into your own products.
API status: live. Create an API key in your QRinst account to use it. Creating and editing dynamic codes over REST is not available yet.
POST /functions/v1/api-qr
Authorization: Bearer qri_live_xxxxxxxxxxxx
{ "type": "url", "url": "https://example.com", "format": "png" }
200 OK
Content-Type: image/png
X-RateLimit-Remaining-Month: 999Live endpoint, real headers. Switch tabs to see the Faviqo install code.
QRinst
How QRinst works
Every QRinst code is a redirect. The printed pattern encodes a short URL on an MDXTORA domain. When a phone scans it, the redirect service looks up the short code, records the scan and responds with an HTTP redirect to the current destination. Because the lookup happens at scan time, the destination can be edited freely while the printed code stays exactly the same.
The redirect path is intentionally tiny so scans feel instant even on slow mobile connections: one lookup, one recorded event, one redirect. If recording a scan ever fails, the visitor is still sent to the destination.
- 01
Scan
A phone reads the printed pattern, which holds a short URL.
- 02
Look up
The redirect service finds the short code and records the scan.
- 03
Redirect
The visitor is sent to the current destination, even if recording failed.
Vocabulary
Core concepts
- QR code
- A record with a name, a destination and a short code. The printed pattern encodes the short URL, never the destination.
- Short code
- The unique identifier in the redirect URL. It never changes for the life of the code, which is what makes printed codes safe to edit.
- Destination
- Where a scan is redirected. It can be changed at any time without touching the printed code.
- Scan
- One recorded visit to a short URL. Bot traffic is filtered out, scans are counted for as long as the code exists, and the detailed scan history is kept for 60 days.
Reference
QR generation API
One endpoint: send a JSON POST and get a PNG or SVG QR code back. Sign in to QRinst, create an API key under API Keys, and call the endpoint. The full field reference per code type is in the QRinst API docs.
https://ywhutayfwmfltrezwoll.supabase.co/functions/v1/api-qr- type
- Required. One of: url, text, wifi, email, phone, sms, vcard, whatsapp, event, social, location, bitcoin.
- size
- Optional. Pixels, 64–2000. Default 512.
- format
- Optional. "png" (default) or "svg".
- type fields
- Each type has its own fields, for example url for "url", or ssid, password and security for "wifi".
curl -X POST https://ywhutayfwmfltrezwoll.supabase.co/functions/v1/api-qr -H "Authorization: Bearer qri_live_xxxxxxxxxxxx" -H "Content-Type: application/json" -d '{"type":"url","url":"https://example.com","size":512,"format":"png"}' -o qr.pngHTTP/1.1 200 OK
Content-Type: image/png
X-RateLimit-Limit-Minute: 10
X-RateLimit-Remaining-Minute: 9
X-RateLimit-Limit-Month: 1000
X-RateLimit-Remaining-Month: 999
<binary PNG data>Limits
| Plan | Per month | Per minute |
|---|---|---|
| Free | 1,000 | 10 |
| Pro | 50,000 | 60 |
Error codes
- 401
MISSING_API_KEYNo Authorization header, or the key is malformed.
- 401
INVALID_API_KEYKey not found or revoked.
- 400
INVALID_TYPE"type" is missing or not a supported static type.
- 400
INVALID_FIELDSRequired fields for that type are missing or malformed.
- 429
RATE_LIMITEDPer-minute limit reached. A Retry-After header is included.
- 429
MONTHLY_QUOTA_EXCEEDEDMonthly request quota used up.
Integration
Authentication, limits and errors
Authentication
Send your API key in an Authorization: Bearer header. Keys start with qri_live_, are created and revoked under API Keys in your QRinst dashboard, and belong to your account. Keep keys on your server, never in client-side code or public repositories.
Rate limits
Limits apply per key and per month (see the table above). Every response includes X-RateLimit-Limit-Minute, X-RateLimit-Remaining-Minute, X-RateLimit-Limit-Month and X-RateLimit-Remaining-Month headers so clients can back off gracefully.
Errors
Errors use standard HTTP status codes with a JSON body of the form { "error": { "code", "message" } }, so clients can handle failures without parsing text.
Static codes only
The endpoint renders static codes, which encode their content directly and are not tracked. Dynamic codes (PDF, image, video, app, business card, menu) are created in the QRinst dashboard; creating and editing them over REST is not available yet.
Faviqo
Using Faviqo in your project
Faviqo has no API and no server. It generates icons in the browser and gives you files plus markup, so there is nothing to integrate beyond placing the output in your project. Upload the files to your site root and paste the generated snippet into your page head.
<link rel="icon" href="/favicon.ico" sizes="48x48">
<link rel="icon" href="/favicon.svg" type="image/svg+xml">
<link rel="apple-touch-icon" href="/apple-touch-icon-180x180.png">
<link rel="manifest" href="/site.webmanifest">Framework-specific install code for Next.js, React, Vue, Angular, WordPress, Shopify and Webflow is available at faviqo.mdxtora.com. Keep icon files small, serve them over HTTPS and link them with absolute paths from the site root.
Checklist
Integration best practices
- Always encode a short redirect URL rather than a long destination. Short data means a simpler pattern that scans more reliably.
- Generate codes as vector images (SVG) for print and as PNG at generous resolution for screens. Never upscale a raster image.
- Leave a quiet zone of at least four modules around every code and keep strong contrast between modules and background.
- Use consistent, lowercase UTM parameters on destination links so campaign reports stay clean.
- Serve destination pages over HTTPS and keep them fast on mobile connections, since every scan ends there.
- Treat API keys as secrets: store them in environment variables, rotate them periodically and use a separate key per environment.
- Never place personal data in a QR code's destination URL. URLs end up in logs, browser history and analytics.
Journal
Further reading
- ProductHow I built a production QR platform
- ProductWhy I built a favicon generator that never uploads your logo
- GuideFavicon sizes in 2026: what you actually need
- EngineeringBuilding scalable React applications
- GuideUnderstanding QR code technology
- GuideTracking QR campaigns with UTM parameters
Need something we don’t offer yet?
Dynamic codes over REST, or another integration? Tell us what you are building.
Get in touch