API Integration

The QRelix API enables developers to programmatically generate, manage, and track QR codes at scale. Whether you're building batch generation workflows, integrating with e-commerce platforms, or automating marketing campaigns, our API provides the tools to seamlessly embed QR code functionality into your applications.

Overview

QRelix's REST API gives you complete control over QR code operations. Generate codes on-demand, update destinations dynamically, retrieve real-time analytics, and manage your entire QR code library through simple API calls.

Key Capabilities

  • Programmatic Generation — Create QR codes dynamically without touching the dashboard
  • Batch Operations — Generate multiple codes in a single request
  • Dynamic Updates — Change QR code destinations without regenerating the code
  • Analytics Retrieval — Access scan data, geographic distribution, and engagement metrics
  • Code Management — Organize, tag, and retrieve QR codes across your portfolio

Authentication

All API requests require authentication via an API key. Your API key acts as a credential for your QRelix account and must be included in request headers.

Obtaining Your API Key

  1. Log in to your QRelix dashboard
  2. Navigate to Settings → API & Integrations
  3. Click Generate API Key
  4. Copy your key and store it securely (it won't be displayed again)

Using Your API Key

Include your API key in the Authorization header of every request:

{
  "Authorization": "Bearer YOUR_API_KEY"
}

:::note API access requires an active QRelix subscription. Contact support for API key provisioning. :::

Core Endpoints Overview

Create QR Code

Generate a new QR code with a specified destination URL.

Request Example:

{
  "method": "POST",
  "endpoint": "/api/v1/qr-codes",
  "headers": {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  "body": {
    "destination_url": "https://example.com/landing",
    "custom_slug": "campaign-2026",
    "size": "medium",
    "color": "#000000"
  }
}

Response Example:

{
  "success": true,
  "data": {
    "qr_code_id": "qrc_abc123xyz",
    "short_url": "qrelix.com/campaign-2026",
    "destination_url": "https://example.com/landing",
    "created_at": "2026-04-08T14:32:00Z",
    "scans": 0
  }
}

Update Destination

Change the destination URL of an existing QR code without regenerating the code itself.

Request Example:

{
  "method": "PATCH",
  "endpoint": "/api/v1/qr-codes/{qr_code_id}",
  "headers": {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  "body": {
    "destination_url": "https://example.com/new-landing"
  }
}

Retrieve Analytics

Fetch detailed scan and engagement metrics for a specific QR code.

Request Example:

{
  "method": "GET",
  "endpoint": "/api/v1/qr-codes/{qr_code_id}/analytics",
  "headers": {
    "Authorization": "Bearer YOUR_API_KEY"
  },
  "query_params": {
    "date_from": "2026-03-01",
    "date_to": "2026-04-08"
  }
}

Response Example:

{
  "success": true,
  "data": {
    "qr_code_id": "qrc_abc123xyz",
    "total_scans": 1247,
    "unique_scans": 892,
    "top_devices": ["iPhone", "Android", "Desktop"],
    "top_locations": ["New York", "Los Angeles", "Chicago"],
    "scan_trend": [
      { "date": "2026-04-01", "scans": 142 },
      { "date": "2026-04-02", "scans": 156 }
    ]
  }
}

Manage QR Codes

List, filter, and organize your QR codes with powerful management endpoints.

Request Example:

{
  "method": "GET",
  "endpoint": "/api/v1/qr-codes",
  "headers": {
    "Authorization": "Bearer YOUR_API_KEY"
  },
  "query_params": {
    "status": "active",
    "tags": ["campaign", "2026"],
    "limit": 50,
    "offset": 0
  }
}

Use Cases

Batch QR Code Generation

Generate hundreds of unique QR codes for a product launch or promotional campaign in a single workflow.

{
  "batch_name": "Summer Sale 2026",
  "codes": [
    {
      "destination_url": "https://example.com/summer-sale-1",
      "custom_slug": "summer-sale-1"
    },
    {
      "destination_url": "https://example.com/summer-sale-2",
      "custom_slug": "summer-sale-2"
    }
  ]
}

E-Commerce Integration

Embed QR codes directly on product listings, receipts, and packaging for seamless customer engagement.

Event Ticketing

Create unique QR codes for each event attendee, dynamically linking to personalized landing pages or check-in URLs.

Marketing Automation

Automatically generate campaign-specific QR codes triggered by user actions, seasonal events, or CRM workflows.

Webhooks (Coming Soon)

We're building webhook support to notify your systems in real-time when QR codes are scanned. Upcoming features include:

  • Scan Notifications — Receive instant alerts when a QR code is scanned
  • Custom Triggers — Set thresholds and conditions for automated alerts
  • Batch Events — Aggregate scan data into scheduled batch reports

Watch this space for webhook documentation and implementation guides.

Rate Limits & Best Practices

Rate Limiting

  • Standard Plans — 1,000 requests per hour
  • Pro Plans — 10,000 requests per hour
  • Enterprise Plans — Custom limits available

Requests exceeding your limit will receive a 429 Too Many Requests response.

Best Practices

  1. Cache Responses — Store frequently accessed QR code data to minimize API calls
  2. Batch Operations — Group multiple code creations into single requests where possible
  3. Error Handling — Implement retry logic with exponential backoff for transient errors
  4. Secure Keys — Never commit API keys to version control; use environment variables
  5. Monitor Usage — Track your API consumption in the dashboard to stay within rate limits
  6. Test Thoroughly — Use a test API key in development before deploying to production

Next Steps

Ready to integrate? Explore these related guides: