Skip to main content

Introduction to QR Code Generation API

Welcome to the QR Code Generation API documentation. This API allows you to generate highly customizable QR codes with ease. Whether you need a simple QR code for a URL or a more complex one with embedded images, unique color schemes, and different error correction levels, this API has you covered.

Key Features​

  • Customizable QR Codes: Adjust the size, colors, and shape of your QR codes to fit your specific design needs.
  • Embedded Images: Add logos or images to the center of your QR codes for branding purposes.
  • Multiple Formats: Generate QR codes in various formats, including PNG, JPG, SVG, and PDF.
  • Flexible Error Correction: Choose from different levels of error correction to ensure your QR codes are readable even when partially damaged.

Endpoint​

This API allows you to generate QR codes for various use cases, such as opening an email client, dialing a phone number, sending an SMS, or displaying contact information in vCard or MeCard format. Each route provides a different type of QR code based on the query parameters passed.

1. Root Route /​

Description:
Generates a QR code based on the provided query parameters.

Method:
GET

2. Email Route /email​

Description:
Generates a QR code that opens the email client with a mailto link formed from the provided query parameters.

Method:
GET

3. Phone Route /phone​

Description:
Generates a QR code for dialing a phone number using the tel link.

Method:
GET

4. SMS Route /sms​

Description:
Generates a QR code for sending an SMS with a pre-filled message using the SMSTO link.

Method:
GET

5. vCard Route /vcard​

Description:
Generates a QR code containing vCard information, which includes details like name, organization, and contact numbers.

Method:
GET

6. MeCard Route /mecard​

Description:
Generates a QR code for a MeCard, which is a simplified contact card format often used in QR codes.

Method:
GET

Getting Started with the API​

This documentation will guide you through the available endpoints, how to structure your requests, and what responses to expect. Each section includes examples to help you get up and running quickly.

Prerequisites for the API​

To use this API, you should have:

  • A basic understanding of HTTP requests.
  • Familiarity with JSON format, as it's used to pass parameters to the API.

The API is hosted locally and runs on port 8080. Ensure your server is up and running to start generating QR codes.

Code Example​

Here is an example of how you can make a request to the API:

"http://localhost:8080/?data=Hello%20World&format=png"