API
Get started with the QRcodly API
Welcome to the QRcodly API documentation 👋 This guide will help you get started with the API, generate your API key, and understand plan limitations.
Overview
The QRcodly API allows you to programmatically generate and manage QR codes using the same engine that powers qrcodly.de. It is designed to be simple, fast, and scalable for both small projects and production use cases.
The API is fully documented using OpenAPI and can be integrated into any modern backend or frontend stack.
Step 1: Download the OpenAPI Specification
QRcodly provides an OpenAPI (Swagger) specification that you can import into tools like:
- Postman
- Insomnia
- ... other API Clients
You can download the specification here:
https://api.qrcodly.de/api/v1/openapi.jsonImporting the OpenAPI file into Postman or other API Clients is the fastest way to explore and test the API.
Step 2: Create an API Key
To authenticate requests, you need an API key.
How to create an API key
- Log in to your QRcodly account
- Click on the profile icon in the top-right corner
- Select Manage account
- Navigate to API Keys
- Create a new API key
Keep your API key secret. Do not expose it in public repositories or client-side code.
Your API key is shown only once during creation and cannot be viewed again. Make sure to store it securely (for example in a password manager or environment variables). If the key is lost or compromised, you must generate a new one.
Once created, include the API key in your requests as required by the API documentation.
Authentication
All API requests must be authenticated using your API key.
Usage:
Authorization: Bearer YOUR_API_KEYRate Limits & Plans
QRcodly offers different limits depending on your subscription plan.
Free Plan
- Limited number of API requests
- Strict rate limiting
Pro Plan (coming soon)
- Unlimited API requests
- Much more relaxed rate limiting
- Ideal for production use and high-traffic applications
Happy building with the QRcodly API 🚀