Login  

QRGen API - A Dynamic QR Code Image Generator

Introduction

QRGen is an API that enables you to create custom dynamic QR Codes that are optimized for North American mobile camera phones. Based on the data payload we have optimized the compression, size, and error correction code parameters. Our goal is to make it as easy and painless as possible for you to embed dynamic QR Codes in to your application.

Usage

  • *We now support HTTPS (SSL) for integration of QR Codes with secure websites.
  • Include the following in an <IMG> tag as if it were an image location .../qrgen?... examples and parameters are listed below.

PHONE CALL
Scanning a QR code with this symbol will invoke your phone to dial the number embedded in the QR code.

Ex: http://www.mskynet.com/qrgen?qt=ph&tel=800GOOG411&...

http://www.mskynet.com/qrgen?qt=ph&tel=\p
  • \p - replace with a alpha-numeric phone number to call, e.g. "800GOOG411".
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: phone number)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
Call
sms

SMS TEXT MESSAGE
Scanning a QR code with this symbol will invoke your phone to send an SMS text message to the number embedded in the QR code.

Ex: http://www.mskynet.com/qrgen?qt=sms&tel=44636&data=joke&...

http://www.mskynet.com/qrgen?qt=sms&tel=\p&data=\d
  • \p - replace with a alpha-numeric phone number to send SMS to, e.g. "44636".
  • \d - replace with a message to send, e.g. "joke".
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: sms text info)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
Send SMS
map

GPS MAP
Scanning a QR code with this symbol will invoke your phone to open a map to the geocoded location specified.

Ex: http://www.mskynet.com/qrgen?qt=map&data=Space+Needle&...

http://www.mskynet.com/qrgen?qt=map&data=\d
  • \d - replace with a location to geocode for mapping, e.g. "Space Needle".
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: city location)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
GoTo URL
url

URL
Scanning a QR code with this symbol will invoke your phone browser to open this url.

Ex: http://www.mskynet.com/qrgen?qt=url&data=http://mskynet.com&...

http://www.mskynet.com/qrgen?qt=url&data=\d
  • \d - encoded url to open, e.g. "http://mskynet.com".
  • track - allows you to track the usage of your barcode.
  • tiny - 0 to disable compression. (default: compression enabled, 1).
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: url)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
** Default: we compress the URL (tiny=1) since most mobile cameras do not support macro focusing and so high density QR codes may not be scannable. 		GoTo URL
blackberry_pin

BlackBerry PIN
Scanning a QR code with this symbol will add this PIN request to your BlackBerry contacts.

Ex: http://www.mskynet.com/qrgen?qt=bb&fName=Pete&...

http://www.mskynet.com/qrgen?qt=bb&fName=\f
    &data=\p
  • \f - Display Name, e.g. "Pete Mitchell".
  • \p - BlackBerry PIN (8-digits)
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: Add * to Contact)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
Blackberry Contact
mecard

MeCARD
Scanning a QR code with this symbol will add this MeCARD to your phone contact list.

Ex: http://www.mskynet.com/qrgen?qt=addr&fName=Pete&...

http://www.mskynet.com/qrgen?qt=addr&fName=\f
    &lName=\l&tel=\t&address=\a&city=\c&state=\s
    &zip=\z&country=\r&email=\e&url=\u
  • \f - First Name, e.g. "Pete".
  • \l - Last Name, e.g. "Mitchell".
  • \t - Telephone Number.
  • \a - Addresss, e.g. "123 Main St.".
  • \c - City, e.g. "Miramar".
  • \s - State, e.g. "CA"
  • \a - Zip Code, e.g. "90210"
  • \r - Country, e.g. "US"
  • \e - Email, e.g. "maverick@topgun.com".
  • \u - Url, e.g. "topgun.com"
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: Add * to Contact)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
meCard
vcard

vCard
Scanning a QR code with this symbol will add this vCard to your phone contact list.**

Ex: http://www.mskynet.com/qrgen?qt=vcard&fName=Pete&...

http://www.mskynet.com/qrgen?qt=vcard&fName=\f
    &lName=\l&company=\k&title=\j&tel=\t
    &mobile=\m&address=\a&city=\c&state=\s
    &zip=\z&country=\r&email=\e&url=\u
  • \f - First Name, e.g. "Pete".
  • \l - Last Name, e.g. "Mitchell".
  • \k - Company, e.g. "US Navy".
  • \j - Job Title, e.g. "Naval Aviator".
  • \t - Telephone Number.
  • \m - Mobile Number.
  • \a - Addresss, e.g. "123 Main St.".
  • \c - City, e.g. "Miramar".
  • \s - State, e.g. "CA"
  • \a - Zip Code, e.g. "90210"
  • \r - Country, e.g. "US"
  • \e - Email, e.g. "maverick@topgun.com".
  • \u - Url, e.g. "topgun.com"
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: Add * to Contact)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
** Note: This feature currently works with Windows Mobile and the BlackBerry only. 		vCard
vcal

vCal (Calendar)
Scanning a QR code with this symbol will add this event to your calendar.

Ex: http://www.mskynet.com/qrgen?qt=vcal&title=Birthday&...

http://www.mskynet.com/qrgen?qt=vcal&title=\t
    &desc=\d&loc=\l&email=\e
    &sYear=\sy&sMonth=\sm&sDay=\sd
    &sHour=\sh&sMin=\sn&sOffset=\so
    &eYear=\ey&eMonth=\em&eDay=\ed
    &eHour=\eh&eMin=\en&eOffset=\eo
    &alarm=\a
*Note: Please URL encode the following parameters.
  • \t - Title, e.g. "Birthday".
  • \d - Description, e.g. "Barcode's 58th Birthday!".
  • \l - Location, e.g. "Seattle, WA".
  • \e - Organizer's Email, e.g. "noreply@mskynet.com".
  • Start date/time
    • \sy - Event start year, e.g. "2010"
    • \sm - Event start month, e.g. "10"
    • \sd - Event start day, e.g. "07"
    • \sh - Event start hour, e.g. "12"
    • \sn - Event start minute, e.g. "30"
    • \so - Event start UTC offset, e.g. "-8" for (PST)
  • End date/time
    • \ey - Event end year, e.g. "2010"
    • \em - Event end month, e.g. "10"
    • \ed - Event end day, e.g. "07"
    • \eh - Event end hour, e.g. "13"
    • \en - Event end minute, e.g. "30"
    • \eo - Event end UTC offset, e.g. "-8" for (PST)
  • \a - Alarm in minutes, e.g. "15". (default: disabled)
  • width - width in pixels. (default: autosize)
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: Add * to Contact)
  • nocap - 1 to disable subcap. (default: enabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
calendar
raw

RAW
Scanning a QR code with this symbol will invoke any action of your choosing. This is meant for custom made QR codes where you can embed any raw data of your choosing for testing and custom application development.

Ex: http://www.mskynet.com/qrgen?qt=raw&data=Hello,+TRE!&...

http://www.mskynet.com/qrgen?qt=raw&data=\d
  • \d - encocded data string, e.g. "Hello,+TRE!".
  • width - width in pixels (default: autosize).
  • cap - url encoded caption text. (default: none)
  • subcap - url encoded subcaption text. (default: none)
  • nocap - 1 to disable subcap. (default: disabled, 0)
  • col - hex color value. (default: black, '000000')
  • bgcol - hex color value. (default: white, 'FFFFFF')
Raw Data

Advanced Parameters

By default QRGen will automatically compute the optimum values targeted for North American phones based on the data provided. For some background as to what these parameters do we recommend you read http://www.denso-wave.com/qrcode/aboutqr-e.html

  • width (no default)
  • ecc (default: auto)
  • ver (default: auto)
  • cap (default: none)
  • subcap (default: description of what you're doing)
  • nocap (default: off)
  • color (default: '000000' - Black)
  • background color (default: 'FFFFFF' - White)

Width

The desired width of the image. If none is supplied the width of your image is determined by the size parameter. We advise using this parameter rather than trying to fiddle with the size parameter.

  • Parameter Type: numeric
  • Valid range: 15-500

Ecc

This determines the error correction level of the QR code. We strongly recommend that you let us pick which ECC level to use. If you insist on picking it yourself please read "Error Correction" on http://www.denso-wave.com/qrcode/qrgene2-e.html.

  • Parameter Type: character
  • Valid Range: H, Q, M, L

Ver

The version of the QR Code to read. This is a parameter that we strongly recommend let us pick for you. If you're a control freak and just have to specify it, please read http://www.denso-wave.com/qrcode/qrgene2-e.html first.

  • Parameter Type: numeric
  • Valid Range: 1 - 40. Anything above four will have problems being read by North American Phones.

Cap

This is some text rendered just beneath the QR Code in bold text. It should be something short, like a title for the QR code.

  • Parameter Type: string

Subcap

This is some text rendered just beneath the main caption. It can be a little bit longer than the caption but you don't have a lot of room to work with. Note that subcaptions can be hard to read if your QR code width is less than 300 pixels.

  • Paramter Type: string

NoCap

Instructs the generator to disable the subcaption.

  • Parameter Type: numeric
  • Valid Range: 0 - 1

Color

Generate image using this color foreground.

  • Parameter Type: string
  • Hexadecimal string representing RGB color values: RGB(0,0,255) = '0000FF'

Background Color

Generate image using this color background.

  • Parameter Type: string
  • Hexadecimal string representing RGB color values: RGB(255,0,0) = 'FF0000'



  About Us     Terms of Use     Ping TRE