API Documentation
Integrate QR Experiences directly into your applications with our powerful API.
Getting Started
To use the QR Experiences API, you'll need an API key. You can generate one in your dashboard.
Authentication
All API requests must include your API key in the Authorization header:
Authorization: Bearer qrexp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxBase URL
https://api.qrexperiences.com/v1Create QR Code
Generate a new QR code with custom parameters.
Endpoint
POST https://api.qrexperiences.com/v1/qrcodesRequest Body
{
"url": "https://example.com",
"name": "My QR Code",
"options": {
"foregroundColor": "#000000",
"backgroundColor": "#FFFFFF",
"logoUrl": "https://example.com/logo.png",
"shape": "rounded"
}
}Response
{
"id": "qr_123456789",
"url": "https://example.com",
"name": "My QR Code",
"shortUrl": "https://l2x.co/abc123",
"qrCodeUrl": "https://qrexperiences.com/qr/abc123.png",
"createdAt": "2023-05-01T12:00:00Z"
}Rate Limits
To ensure fair usage and system stability, our API implements the following rate limits:
| Plan | Rate Limit | Burst Limit |
|---|---|---|
| Free | 60 requests/hour | 10 requests/minute |
| Pro | 1,000 requests/hour | 60 requests/minute |
| Business | 10,000 requests/hour | 300 requests/minute |
| Enterprise | Custom | Custom |
Rate limit headers are included in all API responses to help you track your usage:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1620000000Error Handling
Our API uses conventional HTTP response codes to indicate the success or failure of an API request:
- 2xx: Success
- 4xx: Client errors (e.g., invalid request, authentication issues)
- 5xx: Server errors
Error responses include a JSON object with more details:
{
"error": {
"code": "invalid_request",
"message": "The URL parameter is required",
"status": 400,
"details": {
"field": "url",
"reason": "required"
}
}
}