Introduction
The EZQR REST API lets you create QR codes, change destinations, read analytics and subscribe to events.
The EZQR API is a JSON REST API. Use it to create static and dynamic QR codes from your own product, update where dynamic codes point, pull scan analytics and subscribe to events.
Base URL
https://ez-qr.com/api/v1Every request and response body is JSON. Send Content-Type: application/json with request bodies.
Authentication
Authenticate with an API key in the Authorization header. Create keys in Settings → API keys. The API is available on the Max plan.
curl https://ez-qr.com/api/v1/me \
-H "Authorization: Bearer ezqr_your_api_key"See Authentication for details.
Your first request
Create a dynamic QR code that points to your menu:
curl https://ez-qr.com/api/v1/qr-codes \
-H "Authorization: Bearer $EZQR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Spring menu",
"type": "dynamic",
"contentType": "url",
"content": "https://example.com/menu"
}'The response contains the code's shortCode. Scans of https://ez-qr.com/r/{shortCode} redirect to your destination, and you can change it later with Update a QR code.
Responses
Successful responses wrap the resource in data:
{
"data": {
"id": "6f0c3c1e-6a9e-4b8a-9b0e-2f8f2a1d6c11",
"name": "Spring menu",
"type": "dynamic",
"shortCode": "k3x9QpL",
"targetUrl": "https://example.com/menu",
"isActive": true,
"totalScans": 0
}
}Errors return an error message and an HTTP status. See Errors.