二维彩虹API文件

我们的自定义二维码API能为商家提供专业的解决方案,无论您是需要带有追踪系统的自定义二维码模板、动态二维码、批量二维码还有需要将二维码整合到CRM之中。

有任何其他问题,您可以随时与我们联系,我们的API可以在世界范围内使用,联系我们以获取更多信息。我们也可以为移动支付来设计定制二维码。

API结果示例:
example 1
example 2
example 3
example 4
example 5

文档

创建二维码

1. 首先登陆并获取API密钥授权
2. 用此API创建自定义视觉二维码。这将创建很容易追踪访问者的动态二维码活动。
网站/campaign
方法GET, POST
响应Binary Image File (PNG, SVG)
GET /campaign/?page=1&limit=5&sort=1
查询参数
参数类型违约描述
pageNumber1no. of page
limitNumber5no. of campaign per page
sortNumber1Sort by Date(1) or Name(2)
POST /campaign
查询参数
参数类型违约描述
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
网站/qrcodes/qr2
方法POST
响应Binary Image File (PNG, SVG)
POST /qrcodes/qr2
查询参数
参数类型违约描述
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)
查询参数
参数Category类型Value
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)
参数类型Value描述
左-右StringlinearGradient flow left to right
从上到下StringupDownGradient flow Top to Bottom
西北 - 东南Stringdiagonal1Gradient flow Digaonaly Downword
南西 - 北东Stringdiagonal2Gradient flow Diagonaly Upword
中心渐变StringradialGradient flow Radially
text/qrUrl (use “text” for Static QR and “qrUrl” for Dynamic QR)
查询参数
Category类型Value
UrlStringurl
WifiStringwifi
VcardStringvcard
Mp3Stringmp3
BitcoinStringbitcoin
FacebookStringfacebook
YoutubeStringyoutube
PinterestStringpinterest
InstagramStringinstagram
EmailStringemail
TextStringtext
eye_outer (Default 0)
参数类型Value描述
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eyeOuter11
eyeOuter12
eye_inner
参数类型Value描述
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
eyeInner10
QrData
参数类型Value描述
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
4. Track your QR Data, No. Of scans, Country, City, Device type.
网站/data/qrid?period=“month”
方法GET
响应JSON object of track data
Request parameter
参数类型描述
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. 上传您的图标
网站/accounts/uploads
方法POST
Content-typemultipart/form-data
Form-FieldFile
响应Image file url {"qrUrl": https://api.qrtiger.com/images/1526460566643-youtube.png}