Getting Started with QR Fast API

Learn how to create your first QR code in under 5 minutes

📋 Prerequisites

• A QR Fast account (sign up at qrfa.st)
• Basic understanding of REST APIs
• A tool to make HTTP requests (cURL, Postman, or code)

Step 1: Create Your Account

1.1 Sign Up

Visit qrfa.st and create your free account. You'll get 10 free dynamic QR codes to start with.

💡 Tip: Use your business email for better organization and team access later.

1.2 Access Your Dashboard

After signing up, you'll be redirected to your dashboard where you can:

View your QR code usage and remaining tokens
Create QR codes manually through the web interface
Manage your API keys
Monitor your QR code analytics

Step 2: Generate Your API Key

2.1 Navigate to API Keys

From your dashboard, click on "Manage API Keys" to access the API key management interface.

Go to API Keys →

2.2 Create Your First API Key

1. Click "Create New API Key"
2. Enter a descriptive name (e.g., "Production App", "Development Testing")
3. Click "Create"
4. Important: Copy the API key immediately - you won't see it again!

⚠️ Security Note: Keep your API key secure and never share it publicly. If compromised, delete it and create a new one.

Step 3: Make Your First API Call

3.1 Test with cURL

Replace YOUR_API_KEY with your actual API key:

curl -X POST https://qrfa.st/api/v1/qrcode \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"targetUrl": "https://example.com"}'

3.2 Expected Response

You should receive a response like this:

{
  "success": true,
  "shortId": "abc123defg",
  "qrCodeUrl": "https://qrfa.st/abc123defg",
  "editUrl": "https://qrfa.st/qrcode/edit/abc123defg",
  "targetUrl": "https://example.com",
  "qrCodeOptions": {
    "width": 300,
    "height": 300,
    "dotsOptions": {
      "type": "square",
      "color": "#000000"
    }
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Step 4: Understanding Your QR Code

4.1 Key Response Fields

shortIdUnique identifier for your QR code

qrCodeUrlThe URL that your QR code points to (scan this!)

editUrlDashboard URL to edit this QR code

targetUrlWhere the QR code redirects when scanned

4.2 Test Your QR Code

1. Visit the qrCodeUrl in your browser
2. You should be redirected to your targetUrl
3. Use a QR code scanner app to scan the QR code at that URL
4. Visit the editUrl to see the QR code in your dashboard

🎉 Congratulations!

You've successfully created your first QR code via the API. Here's what to explore next:

📖 Full API Documentation

Explore all endpoints and advanced features

🧪 Interactive Testing

Test API endpoints directly in your browser

💻 Code Examples

Ready-to-use code in multiple languages

⭐ Best Practices

Security guidelines and optimization tips

Quick Reference Card

Base URL

https://qrfa.st/api/v1

Authentication

Bearer YOUR_API_KEY

Create QR Code

POST /qrcode

Rate Limit

100 requests/15min