API Documentation
API v1

API Documentation

Integrate QR code generation, customization, and analytics into your applications with our REST API. Build powerful QR code workflows with just a few API calls.

Quick Start

Make your first API call in minutes. Here's how to create a QR code:

1

Get your API key

Sign up or log in, then visit the Developers page to create an API key.

2

Make your first request

Use the API key in the X-API-Key header:

Example Request
curl -X POST \
  https://i-love-qr-production-645dbff8d2fe.herokuapp.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "URL",
    "name": "My Website QR",
    "data": {
      "url": "https://example.com"
    }
  }'
Example Response
{
  "id": "qr_abc123",
  "type": "URL",
  "name": "My Website QR",
  "shortUrl": "https://ilqr.co/abc123",
  "data": {
    "url": "https://example.com"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "totalScans": 0
}

Authentication

All API requests require authentication using an API key. Include your key in the request header:

X-API-Key: your_api_key_here

Security Tip: Never expose your API key in client-side code. Always make API calls from your server or use environment variables.

Base URL

All API endpoints are relative to the following base URL:

https://i-love-qr-production-645dbff8d2fe.herokuapp.com/api/v1

Rate Limits

API requests are rate limited to ensure fair usage and platform stability:

Short Term

10

requests/second

Medium Term

50

requests/10 seconds

Long Term

100

requests/minute

API Endpoints

Explore our comprehensive API endpoints organized by functionality:

QR Code Management

Create, update, and manage dynamic QR codes programmatically

Bulk Operations

Create hundreds of QR codes at once via CSV import or API

Analytics

Track scans, locations, devices, and export detailed reports

Webhooks

Receive real-time notifications when QR codes are scanned

Why Choose Our API

Fast & Reliable

Low latency API with 99.9% uptime SLA

Secure by Default

API key authentication with scoped permissions

Rate Limiting

Generous limits with clear error responses

SDKs Coming Soon

We're working on official SDKs for JavaScript, Python, PHP, and more. Sign up to be notified when they're available.

Need Help?

If you have questions about the API or need assistance, check out these resources:

Help CenterContact SupportDeveloper Dashboard