Oops! Facing network problem. Unable to load this page. Refresh

Please Wait...

Hello Guest

logo

FAQs

Help
Center

Developer API

QR Code API

Generate QR Codes programmatically.

Overview

The QR Code API allows developers to generate QR Codes programmatically for URLs, marketing campaigns, products, events, digital menus, documents, and other online resources without using the SPRL dashboard.

By integrating the QR Code API into your applications, you can automatically create QR Codes as part of your workflows, making it easier to distribute information across print and digital channels.


Prerequisites

Before using the QR Code API, ensure you have:

Requirement Description
SPRL Account An active SPRL account.
API Credentials A valid Client ID and Client Key.
HTTPS All API requests must be sent securely over HTTPS.
QR Code API Access Your account must have access to the QR Code API.

How the QR Code API Works

Step Action
1 Authenticate your API request.
2 Submit the content or URL to encode.
3 Optionally configure QR Code settings.
4 The API generates the QR Code.
5 The generated QR Code is returned for use in your application.

Typical Request Data

Depending on the endpoint and supported features, a QR Code request may include:

Parameter Description
Content The URL or text to encode.
QR Code Size Optional dimensions of the generated QR Code.
Image Format Preferred output format, where supported.
Error Correction Level Optional QR Code error correction settings.
Customisation Options Additional styling options if available for your account.

API Response

A successful response typically contains information about the generated QR Code.

Response Item Description
QR Code The generated QR Code image or reference.
Encoded Content The URL or text stored in the QR Code.
Reference ID Unique identifier for the generated QR Code.
Status Indicates whether the request completed successfully.

Common Use Cases

  • Generate QR Codes for short links.
  • Create QR Codes for product packaging.
  • Generate digital restaurant menus.
  • Create event registration QR Codes.
  • Share documents and brochures.
  • Automate QR Code generation within business applications.

Best Practices

  • Verify the destination URL before generating the QR Code.
  • Use HTTPS links whenever possible.
  • Test QR Codes on multiple mobile devices.
  • Use sufficient image resolution for printed materials.
  • Protect your API credentials and monitor API usage.

Troubleshooting

Issue Possible Solution
Authentication failed Verify your Client ID and Client Key.
Invalid request Check the request format and required parameters.
QR Code does not scan Verify the encoded content and test the generated QR Code.
Rate limit exceeded Reduce request frequency and retry after the limit resets.
Permission denied Ensure the QR Code API is available for your account.

Frequently Asked Questions

Can I generate QR Codes automatically?

Yes. The QR Code API is designed for automated generation within websites, applications, and business systems.

Can I generate QR Codes for short URLs?

Yes. The API can be used together with the Short Link API to generate QR Codes for shortened URLs.

Can I customise the generated QR Codes?

Available customisation options depend on the API endpoint and your account features.

Is authentication required?

Yes. Protected QR Code API endpoints require valid API credentials.


Learn More
Continue with the Webhook Integration guide to learn how to receive automated notifications from SPRL, or explore the complete API documentation for endpoint-specific request and response details.
Tip
If you're generating QR Codes for marketing campaigns, consider creating a short link first and then generating a QR Code for that link. This allows you to update the destination later (where supported) while keeping the printed QR Code unchanged.

Need more help?

Our support team is always happy to assist you.

×

We use cookies to improve your experience, analyse traffic, and personalise content. By clicking “Accept”, you consent to the use of cookies as described in our Cookie Policy .

Accept cookies Read our Cookie Policy