API Documentation

Integrate QRLinky into your applications with our RESTful API

API Access Requires Pro Plan

Upgrade to Pro to access the API and create API keys for external integrations.

Getting Started

QRLinky API v2 provides programmatic access to create and manage QR codes and short URLs. All API requests must be authenticated using an API key.

Base URL:

https://api.qrlinky.app/api/v2

Authentication

All API requests require authentication using an API key. Include your API key in the X-API-Key header.

X-API-Key: qrlinky_your_api_key_here

Rate Limits

Rate limits are based on your subscription plan:

Pro Trial

500 requests/month

Pro Active

1,000 requests/month

Rate limit information is included in response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Endpoints

GET/api/v2/qr-codesList all QR codes

POST/api/v2/qr-codesCreate a new QR code

GET/api/v2/qr-codes/:idGet a specific QR code

PUT/api/v2/qr-codes/:idUpdate a QR code

DELETE/api/v2/qr-codes/:idDelete a QR code

GET/api/v2/short-urlsList all short URLs

POST/api/v2/short-urlsCreate a new short URL

PUT/api/v2/short-urls/:idUpdate a short URL

DELETE/api/v2/short-urls/:idDelete a short URL

Code Examples

curl -X POST https://api.qrlinky.app/api/v2/qr-codes \
  -H "X-API-Key: qrlinky_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {
      "type": "URL",
      "data": {
        "url": "https://example.com"
      }
    },
    "style": {
      "templateId": "default",
      "dots": {
        "type": "ROUNDED",
        "color": "#000000"
      },
      "cornersSquare": {
        "type": "ROUNDED",
        "color": "#000000"
      },
      "cornersDot": {
        "type": "ROUNDED",
        "color": "#000000"
      },
      "background": {
        "color": "#FFFFFF"
      }
    },
    "design": {
      "shape": "SQUARE",
      "errorCorrectionLevel": "Q",
      "dimensions": {
        "width": 1000,
        "height": 1000,
        "margin": 0
      }
    }
  }'