Business Plan Required

QRShift Developer API

Integrate dynamic QR code generation into your applications. Full control over creation, management, and analytics.

Authentication

API Key Authentication

All API requests require authentication using your API key. You can create API keys in your dashboard settings.

Option 1: Authorization Header (Recommended)

Authorization: Bearer YOUR_API_KEY

Option 2: X-API-Key Header

X-API-Key: YOUR_API_KEY

Base URL

https://your-domain.com/api/v1

API Endpoints

POST/api/v1/qr

Create QR Code

Create a new dynamic QR code with custom settings

GET/api/v1/qr

List QR Codes

Retrieve a paginated list of your QR codes

GET/api/v1/qr/:id

Get QR Code

Retrieve detailed information about a specific QR code

PUT/api/v1/qr/:id

Update QR Code

Update an existing QR code's properties

DELETE/api/v1/qr/:id

Delete QR Code

Permanently delete a QR code. This cannot be undone.

GET/api/v1/qr/:id/stats

Get Statistics

Retrieve detailed scan analytics for a QR code

Code Examples

Create QR Code with cURL

curl -X POST https://your-domain.com/api/v1/qr \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Website QR",
    "qr_type": "website",
    "target_url": "https://example.com",
    "style_settings": {
      "foregroundColor": "#000000",
      "backgroundColor": "#ffffff",
      "dotsStyle": "rounded"
    }
  }'

Error Handling

HTTP Status Codes

The API uses standard HTTP status codes to indicate success or failure.

Status	Meaning
200	Success - Request completed successfully
400	Bad Request - Invalid parameters or request body
401	Unauthorized - Invalid or missing API key
403	Forbidden - No permission (subscription required or limit reached)
404	Not Found - Resource does not exist
429	Too Many Requests - Rate limit exceeded
500	Server Error - Something went wrong on our end

Error Response Format

{
  "code": 401,
  "message": "Invalid API key",
  "data": null
}

Rate Limits

Business Plan

1,000

requests per hour

Need More?

Ready to Get Started?

Create your API key and start integrating QRShift into your applications today.