Qrtiger APIs Docs

Our custom qr code API offers a professional solution for brands that need to have custom qr code templates with data tracking system, dynamic qr codes or qr codes in bulk and have qr codes integrated in their CRM.

Our API and is available on 'Mashape' for any other questions you can always 'contact us' our API can be used world wide, if you need your QR codes available in China, please contact us. We can also do customized QR code for mobile payments.

Mashape

qrId:
example 1
example 2
example 3
example 4
example 5

Documentation

Create QR Code

1. First login and get the api key to authorise
2. Create a custom Visual QR code with this API. This will create the campaign of Dynamic QR which you can easily track for visitors.
Url/campaign
MethodsGET, POST
ResponseBinary Image File (PNG, SVG)
GET /campaign/?page=1&limit=5&sort=1
Query parameters
ParameterTypeDefaultDescription
pageNumber1no. of page
limitNumber5no. of campaign per page
sortNumber1Sort by Date(1) or Name(2)
POST /campaign
Query parameters
ParameterTypeDefaultDescription
campaign:JSON ObjectPut your url and type of qr code in this object
qrTypeStringqr2
qrUrlStringhttp://qrtiger.com
qr:JSON ObjectDesign your qr code like color, data patterns, eyes etc within this object
sizeNumber500Size of the qr
logoImageString (url)nullAdd any logo url to enable the logo at the center of qr
colorDarkString#5e0bf0Color of the qr patterns
backgroundColorString#ffffffBackground color of the qr. (Note: Always choose bright color for a fully scanable qr)
gradientBooleanfalseSet “true” to enable gradient color
grdTypeNumber0 (Left-to-Right)Check below table for grdType
color01String#5e0bf0Gradient color 1 of qr patterns
color02String#f30505Gradient color 2 of qr patterns
eye_colorBooleanfalseSet “true” to change the eye color
eye_color01String#5e0bf0color of outer eye
eye_color02String#f30505color of inner eye
eye_outerStringeyeOuter0Different design of outer eye, check below table for all design patterns
eye_innerStringeyeInner0Different design of inner eye, check below table for all design patterns
qrDataStringpattern0Different design of qr data patterns, check below table for all design patterns
qrCategoryStringurlcheck below table for all QR Categories
qrFormatStringpngDownload binary image file type “png” or “svg”
3. Static QR code generator
Url/qrcodes/qr2
MethodsPOST
ResponseBinary Image File (PNG, SVG)
POST /qrcodes/qr2
Query parameters
ParameterTypeDefaultDescription
qr:JSON ObjectDesign your qr code like color, data patterns, eyes etc within this object
textStringhttp://qrtiger.comThis is the text of qr code that result after scan. See detail below for all qr category text.
sizeNumber500Size of the qr
logoImageString (url)nullAdd any logo url to enable the logo at the center of qr
colorDarkString#5e0bf0Color of the qr patterns
backgroundColorString#ffffffBackground color of the qr. (Note: Always choose bright color for a fully scanable qr)
gradientBooleanfalseSet “true” to enable gradient color
grdTypeNumber0 (Left-to-Right)Check below table for grdType
color01String#5e0bf0Gradient color 1 of qr patterns
color02String#f30505Gradient color 2 of qr patterns
eye_colorBooleanfalseSet “true” to change the eye color
eye_color01String#5e0bf0color of outer eye
eye_color02String#f30505color of inner eye
eye_outerStringeyeOuter0Different design of outer eye, check below table for all design patterns
eye_innerStringeyeInner0Different design of inner eye, check below table for all design patterns
qrDataStringpattern0Different design of qr data patterns, check below table for all design patterns
qrCategoryStringurlcheck below table for all QR Categories
qrFormatStringpngDownload binary image file type “png” or “svg”
text/qrUrl (use “text” for Static QR and “qrUrl” for Dynamic QR)
Query parameters
ParameterCategoryTypeValue
text/qrUrlUrlStringhttp://qrtiger.com
textWifiString“WIFI:T:WEP/WPA;S:USERNAME;P:PASSWORD;”
text/qrUrlVcardStringCheck below vcard detail
text/qrUrlMp3String“https://soundcloud.com/your mp3 path”
textBitcoinString“bitcoin:Your Address?amount=Your Amount”
text/qrUrlFacebookString“https://facebook.com/”
text/qrUrlFacebookString“https://facebook.com/”
text/qrUrlYoutubeString“https://youtube.com”
text/qrUrlPinterestString“https://pinterest.com/”
text/qrUrlInstagramString“https://instagram.com”
text/qrUrlEmailString“mailto:Your Email Id”
text/qrUrlTextString“Any Text”
Request parameter
{
  "address": {
    "street": "773 Dogwood Road",
    "city": "Tempe",
    "state": "Arizona",
    "country": "USA",
    "postal_code": 85282,
    "location": {}
  },
  "profile_pic": "",
  "name": "Steven Brooks",
  "company": "Henry",
  "title": "Logistics Analyst",
  "email": "steven@henry.com",
  "website": "Your Website",
  "phone": {
    "work": "602-628-7546",
    "private": "1-800-800-8000",
    "mobile": "602-317-6491"
  },
  "bgColor": "#C03E4A",
  "additional_info": ""
}
grdType (Default 0)
ParameterTypeValueDescription
Left - RightStringlinearGradient flow left to right
Top - BottomStringupDownGradient flow Top to Bottom
NW - SEStringdiagonal1Gradient flow Digaonaly Downword
SW - NEStringdiagonal2Gradient flow Diagonaly Upword
RadialStringradialGradient flow Radially
text/qrUrl (use “text” for Static QR and “qrUrl” for Dynamic QR)
Query parameters
CategoryTypeValue
UrlStringurl
WifiStringwifi
VcardStringvcard
Mp3Stringmp3
BitcoinStringbitcoin
FacebookStringfacebook
YoutubeStringyoutube
PinterestStringpinterest
InstagramStringinstagram
EmailStringemail
TextStringtext
eye_outer (Default 0)
ParameterTypeValueDescription
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eyeOuter11
eyeOuter12
eye_inner
ParameterTypeValueDescription
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
eyeInner10
QrData
ParameterTypeValueDescription
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
4. Track your QR Data, No. Of scans, Country, City, Device type.
Url/data/qrid?period=“month”
MethodsGET
ResponseJSON object of track data
Request parameter
ParameterTypeDescription
qrIdparamsUnique id of the qr
periodquery

“day” (Day viz data of current day/ today)

“week” (Day viz data of current week)

“month” (Day viz data of current month)

“months” (Month viz data of the current year)“year” (Yearly data)

Request parameter
{
  "data": {
    "campaign": {
      "bulk": false,
      "scanData": [],
      "_id": "5af2b16a51e9bf439exxxxxx",
      "qrId": "Y9YE",
      "qrType": "qr2",
      "shortUrl": "https://api.qrtiger.com/q/Y9YE",
      "redirectUrl": "http://yourWebsiteUrl.com/",
      "qrName": "Campaign Y9YE",
      "qrImage": "https://api.qrtiger.com/qr/Y9YE.png",
      "owner": "unique user id",
      "scans": "no of scans"
    },
    "scans": 6,
    "data": [
      {
        "_id": {
          "device": "AndroidOS",
          "loc": "IN",
          "city": "Meerut"
        },
        "count": 1
      },
      {
        "_id": {
          "device": "AndroidOS",
          "loc": "IN",
          "city": ""
        },
        "count": 2
      },
      {
        "_id": {
          "device": "AndroidOS",
          "loc": "IN",
          "city": "Moradabad"
        },
        "count": 1
      },
      {
        "_id": {
          "device": "AndroidOS",
          "loc": "IN",
          "city": "Mathura"
        },
        "count": 2
      }
    ],
    "graph": {
      "label": [
        9,
        10,
        16
      ],
      "scans": [
        2,
        2,
        2
      ]
    }
  }
}
5. Upload your logo
Url/accounts/uploads
MethodsPOST
Content-typemultipart/form-data
Form-FieldFile
ResponseImage file url {"qrUrl": https://api.qrtiger.com/images/1526460566643-youtube.png}