API access: Become a QR code generator

With our API you will be able to bulk create QR codes outside our platform.

But first, What’s a QR Code API?

Shhh! Those of you who know, just go ahead and find your code 😉

For the rest of us, with an API you can integrate different programs or apps. An API is an application programming interface that connects one system to another generating interactions between them. In our case we offer both dynamic and static QR Code APIs.

Uses vary from bulk QR codes generation, to QR code with specific images or logos, QR codes for business cards, coupons, and everything you can imagine!

Let’s take a look at some examples of how the API can help your business or campaigns

QR code insights image

Automation
made easy

Our API was built to make your QR generation process smooth and effective. You can easily integrate our QR Code generator with your iOS, Android systems or workflows.

at home

Customization
at scale

Massive creation with your brand guidelines it’s a must for us. That’s why with the API you can generate QR codes with your logo and brand colors!

Built for every
need

Use it for employee IDs, vCards, generate tons of coupons for your customers, share documentation, everything your business needs. We have it or we create it 🙂

Just need to follow 3 simple steps:

  1. API to create Dynamic QR codes
    Go through the documentation for the v1.0 of the uQR.me Dynamic QR codes API. In order to access all the features provided by this API, you should request an API key at info@uqr.me.

  2. Authentication
    All the API calls require an Authorization header with the content Token to ensure you are correctly authenticated.

  3. QR codes
    Here you will find the basic CRUD operations to perform with QR codes, including creating, editing and deleting it.

In order to see the full documentation please refer to this link:

QR Code API for basic black & white QR Codes creation

REQUEST:

Endpoint: https://api.uqr.me/api/1.0/dynamicsqr/{{projectId}}/qrcode/

Headers:

Authorization: “Token ”
Content Type: “application/json”

Method: POST

BODY:
{
"qr_type": "url",
"name": "QR Name",
"fields_data": {
"url": "https://uqr.me",
"title": "My QR Title"
},
"attributes": {
"color": "#000000",
"background_color": "#FFFFFF"
}
}

Code Examples

RESPONSE:

{
'url' => ‘https://uqr.to/XXXX,
'qr_code_image' => 'https://app.uqr.me/qrs/XXXXXXXX.svg'
}

QR Code API for colored QR Codes creation

REQUEST:

Endpoint: https://api.uqr.me/api/1.0/dynamicsqr/{{projectId}}/qrcode/

Headers:

Authorization: “Token ”
Content Type: “application/json”

Method: POST

BODY:
{
"qr_type": "url",
"name": "QR Name",
"fields_data": {
"url": "https://uqr.me",
"title": "My QR Title"
},
"attributes": {
"color": "#E5FCC2",
"background_color": "#594f4f",
"logo_image": "https://uqrmecdn.s3.us-east-2.amazonaws.com/u/16/16-24-logo.png"
}
}

Code Examples

RESPONSE:

{
'url' => ‘https://uqr.to/XXXX,
'qr_code_image' => 'https://app.uqr.me/qrs/XXXXXXXX.svg'
}

Code Examples

RESPONSE:

{
'url' => ‘https://uqr.to/XXXX,
'qr_code_image' => 'https://app.uqr.me/qrs/XXXXXXXX.svg'
}

Advanced QR Codes Settings documentation

Parameter Name

Default Value

Description

color

#000000

Foreground color in the format #RRGGBB

background_color

#FFFFFF

Bkg color in the format #RRGGBB

logo

No logo

URL of the logo to include

logoPercent

 

0.2

 

Value from 0.2 to 1. It can make the QR unreadable. The value 1 is used with transparent PNGs so that the logo is not positioned in the center

errorCorrection

 

 

 

 

0

 

 

 

 

Four levels of error correction are supported, with L being the least thorough and H the most comprehensive.
0 => L
1 => M
2 => Q
3 => H

ParameterValueDescription

color │ #000000 │ Foreground color in the format #RRGGBB

background_color │ #FFFFFF │ Bkg color in the format #RRGGBB
logo │ No logo │ URL of the logo to include
logoPercent │ 0.2 │ Value from 0.2 to 1. It can make the QR unreadable. The value 1 is used with transparent PNGs so that the logo is not positioned in the center.

errorCorrection │ 0 │ Four levels of error correction are supported, with L being the least thorough and H the most compr.
0 => L
1 => M
2 => Q
3 => H

Advanced options: They are used to modify the style and layout of the QR.

Parameter

Value

Description

setEyesAllAtOnce

true

If true, set all large squares with the same shape and color

eye1

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

frame0

eye2

 

frame0

 

Same options as eye1, only taken into account if setEyes
AllAtOnce is set to true

eye3

 

 

frame0

 

 

Same options as eye1, only taken into account if setEyes
AllAtOnce is set to true

eyeBall1

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

ball0

eyeBall2

 

ball0

 

Same options as eyeBall1, only taken into account if setEyes
AllAtOnce is set to true

eyeBall3

 

ball0

 

Only taken into account if setEyes
AllAtOnce is set to true

eye1Color

 

#000000

 

Big square color in #RRGGBB format

eye2Color

 

#000000

 

Only if setAllEyes
AtOnce is false. Big square color in #RRGGBB format

eye3Color

 

#000000

 

Only if setAllEyes
AtOnce is false. Big square color in #RRGGBB format

body

 

 

 

 

 

 

 

square

hasGradient

false

If true, apply a gradient to the QR

gradientColor1

#000000

First color of the gradient

gradientColor2

#000000

Second color of the gradient

gradientType

 

 

 

 

 

 

 

 

 

 

 

linear

 

 

 

 

 

 

 

 

 

 

 

Typology of the gradient. The options are:

– Linear:

– Radial:

ParameterValueDescription
setEyesAllAtOnce │ true │ If true, set all large squares with the same shape and color

eye1 │ frame0 │

 

eye2 │ frame0 │ Same options as eye1, only taken into account if setEyes AllAtOnce is set to true
eye3 │ frame0 │ Same options as eye1, only taken into account if setEyes AllAtOnce is set to true

eyeBall1 │ ball0 │

 

eyeBall2 │ ball0 │ Same options as eyeBall1, only taken into account if setEyesAllAtOnce is set to true
eyeBall3 │ ball0 │ Only taken into account if setEyesAllAtOnce is set to true
eye1Color │ #000000 │ Big square color in #RRGGBB format
eye2Color │ #000000 │ Only if setAllEyesAtOnce is false. Big square color in #RRGGBB format
eye3Color │ #000000 │ Only if setAllEyesAtOnce is false. Big square color in #RRGGBB format

body │ square │

 

hasGradient │ false │ If true, apply a gradient to the QR
gradientColor1 │ #000000 │ First color of the gradient
gradientColor2 │ #000000 │ Second color of the gradient

gradientType │ linear │ Typology of the gradient. The options are:

– Linear:

 

– Radial:

 

Code Examples

RESPONSE:

{
'url' => ‘https://uqr.to/XXXX,
'qr_code_image' => 'https://app.uqr.me/qrs/XXXXXXXX.svg'
}

FAQS

Register to our ENTERPRISE plan and request an API key in order to use the code. Seek assistance from a developer in order to integrate the code properly.

You can create multiple types of QR codes with the API including Website, vCard, Mobile page, Coupon and more.

Yes. Since they are dynamic QR codes, you can update or change their content whenever you want, even after printing them.

The API can be used for inventory, product packaging, employee information, tickets for events, coupons and more.