Sprykit™ API Documentation

Build powerful QR code, landing page, and link management experiences with our comprehensive REST API.

Fast & Reliable

Built on Next.js with edge caching for lightning-fast responses. 99.9% uptime SLA.

Secure by Default

API key authentication with rate limiting. All data encrypted in transit and at rest.

Developer Friendly

RESTful API with predictable responses. OpenAPI 3.1 specification included.

Quick Start

1

Get Your API Key

Generate an API key from your dashboard at Settings → API Keys.

Your API key will look like this:

qr_sk_1234567890abcdef
2

Make Your First Request

Create a QR code with a simple POST request:

curl -X POST https://api.sprykit.com/api/public/qr \
  -H "Authorization: Bearer qr_sk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "destinationUrl": "https://example.com",
    "title": "My First QR Code"
  }'
3

Explore the API

Check out our interactive API reference to explore all available endpoints.

Code Examples

JavaScript / Node.js

const response = await fetch('https://api.sprykit.com/api/public/qr', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer qr_sk_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    destinationUrl: 'https://example.com',
    title: 'My QR Code',
    designSettings: {
      fgColor: '#8B5CF6',
      bgColor: '#FFFFFF',
      errorCorrectionLevel: 'M'
    }
  })
});

const data = await response.json();
console.log('QR Code created:', data.shortUrl);

Python

import requests

response = requests.post(
    'https://api.sprykit.com/api/public/qr',
    headers={
        'Authorization': 'Bearer qr_sk_YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'destinationUrl': 'https://example.com',
        'title': 'My QR Code',
        'designSettings': {
            'fgColor': '#8B5CF6',
            'bgColor': '#FFFFFF',
            'errorCorrectionLevel': 'M'
        }
    }
)

data = response.json()
print(f"QR Code created: {data['shortUrl']}")

PHP

<?php
$ch = curl_init('https://api.sprykit.com/api/public/qr');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer qr_sk_YOUR_API_KEY',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'destinationUrl' => 'https://example.com',
    'title' => 'My QR Code',
    'designSettings' => [
        'fgColor' => '#8B5CF6',
        'bgColor' => '#FFFFFF',
        'errorCorrectionLevel' => 'M'
    ]
]));

$response = curl_exec($ch);
$data = json_decode($response, true);
echo "QR Code created: " . $data['shortUrl'];
?>

API Endpoints Overview

QR Codes

Create, manage, and track QR codes with custom designs and analytics.

GETPOSTPUTDELETE

Landing Pages

Create custom landing pages with drag-and-drop content builder.

GETPOSTPUTDELETE

Link Pages

Bio link pages (Linktree-style) with multiple links and customization.

GETPOSTPUTDELETE

Business Cards

Digital business cards with vCard download support.

GETPOSTPUTDELETE

Analytics

Track scans, views, and engagement metrics with detailed analytics.

GET

Domains

Manage custom domains with DNS verification.

GETPOST

Authentication

The Q-lnk API uses API keys to authenticate requests. You can create and manage your API keys from your dashboard.

Important: Keep your API keys secure. Do not share them in publicly accessible areas such as GitHub, client-side code, etc.

Two Ways to Authenticate

1. Bearer Token (Recommended)

Authorization: Bearer qr_sk_YOUR_API_KEY

2. API Key Header

X-API-Key: qr_sk_YOUR_API_KEY

Rate Limits

API requests are rate-limited based on your subscription plan:

PlanRequests/MinuteRequests/Hour
Free601,000
Starter1205,000
Growth30015,000
EnterpriseCustomCustom

Rate limit headers are included in all API responses:

  • X-RateLimit-Limit - Your rate limit
  • X-RateLimit-Remaining - Remaining requests
  • X-RateLimit-Reset - Time when limit resets

Need Help?

Our support team is here to help you build amazing experiences with Sprykit.