Developer API Documentation

Integrate Qryx’s robust QR Code generation and URL Shortener capabilities directly into your own applications.

API Reference

Introduction

The Qryx API is organized around REST. All API requests must be sent securely via HTTPS. Our API has predictable, resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs.

Base URL
https://www.qryx.in/api/v1
Standard HTTP Methods
Method Usage
GET Retrieve a resource or a list of resources.
POST Create a new resource.
PUT Update an existing resource.
DELETE Remove a resource.

Authentication

The Qryx API uses API keys to authenticate requests. You can view and manage your API key under the **API Integration** section in your dashboard. Your API key is secret, so please do not share it or expose it in client-side code.

All API requests must include the API key in the request headers:

X-API-KEY: your_api_key_here
Authentication Failure Response
{
  "success": false,
  "error": "Invalid API Key."
}

QR Codes API Reference

GET /qrcodes

Retrieve a list of all QR Codes created by your authenticated account.

GET /qrcodes/{id}

Retrieve the configurations and details of a single QR Code by its numeric ID.

POST /qrcodes

Create a new static or dynamic QR Code. The request body must contain JSON or form data parameters.

Request Parameters:
  • name (string, Required) - Label for identification.
  • type (string, Required) - "Static" or "Dynamic".
  • format (string, Required) - "URL", "Text", "Phone", or "Email".
  • destinationUrl (string, Optional) - Target URL (required for Dynamic Type).
  • staticContent (string, Optional) - Content to encode (required for Static Type).
PUT /qrcodes/{id}

Update fields on an existing QR Code. Dynamic codes can update the `destinationUrl` if supported by your subscription plan.

DELETE /qrcodes/{id}

Delete a QR Code permanetly from your account.

Code Sample: Create QR Code

curl -X POST "https://www.qryx.in/api/v1/qrcodes" \
  -H "X-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My API QR",
    "type": "Dynamic",
    "format": "URL",
    "destinationUrl": "https://example.com"
  }'
fetch("https://www.qryx.in/api/v1/qrcodes", {
  method: 'POST',
  headers: {
    'X-API-KEY': 'your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'My API QR',
    type: 'Dynamic',
    format: 'URL',
    destinationUrl: 'https://example.com'
  })
})
.then(res => res.json())
.then(data => console.log(data));
import requests

url = "https://www.qryx.in/api/v1/qrcodes"
headers = {
    "X-API-KEY": "your_api_key",
    "Content-Type": "application/json"
}
payload = {
    "name": "My API QR",
    "type": "Dynamic",
    "format": "URL",
    "destinationUrl": "https://example.com"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

Short Links API Reference

GET /shorturls

Retrieve a list of all shortened links created by your authenticated account.

GET /shorturls/{id}

Retrieve details of a single shortened link by its numeric ID.

POST /shorturls

Create a new shortened URL redirection link.

Request Parameters:
  • destinationUrl (string, Required) - Target URL to redirect to.
  • name (string, Optional) - Custom label for this shortened URL.
PUT /shorturls/{id}

Update configurations (name, status, target URL) of an existing short link.

DELETE /shorturls/{id}

Delete a shortened URL link.

Code Sample: Create Short Link

Mayra
AI Assistant (Active Context)
Hello! I am Mayra, your context-aware Qryx AI assistant. Ask me anything about our QR generator, link shortener, pricing plans, developer API, or support!