QR Code

With the QRCode Generation API, you can easily generate QR codes for use in various applications. The API provides a range of customization options allowing you to create unique QR codes tailored to your needs. It also offers a wide range of data types to encode, such as URLs, text, contact information, and more. The API is designed to be fast, secure, and easy to use, making it an ideal choice for developers looking to integrate QR codes into their systems or workflows.

Response Properties

Name
qr
Type
string
Description
The QR Code in image format.

POST/v1/qr/create

Create QR Code

This API allows you to create custom QR codes for any purpose. It is accessible via POST and GET requests. This means that you can access it from any device or platform that supports these methods. Once you create a QR code, you can use it for any purpose, such as sharing webpages, making payments, or providing access to secure information.

Required attributes

Name
data
Type
string
Description
The content you want to put in your QR Code (e.g. URL).

Optional attributes

Name
size
Type
number
Description
Limit to attachments from a given conversation.
Name
download
Type
boolean
Description
Set to true if you want to store the QR code on our servers ang get the code as a link.
Name
format
Type
string
Description
The output file format for your QR code. Formats available: "png" or "svg".
Name
color
Type
object
Description
The colors of the QR Code. Value must be in hex format (RGBA).
Name
campaign
Type
string
Description
Assign this QR code to campaign
Name
tags
Type
string
Description
Tag this QR code to improve your statistics results

Request

POST

/v1/qr/create

  curl -X POST "https://api.hoppah.io/v1/qr/create"  
      -H "x-api-key: {ApiKey}" 
      -H "Content-Type: application/json" -d '{
      "data": "https://www.google.com",
      "size": 200,
      "download": false,
      "campaign": "facebook",
      "tags": "product20, website",
      "format": "png",
      "color": {
          "light": "#FFF",
          "dark": "#000"
      }
  }'

Response

QR code Image png/svg