QRTIGER API-uri Documente

API-ul nostru personalizat de cod QR oferă o soluție profesională pentru brandurile care trebuie să aibă șabloane personalizate de coduri QR cu sistem de urmărire a datelor, coduri QR dinamice sau coduri QR în masă și au coduri QR integrate în managementul relațiilor cu clienții.

API-ul nostru este disponibil pe „Mashape” pentru orice alte întrebări pe care le puteți adresa oricând prin formularul „contactați-ne”. API-ul nostru poate fi folosit la nivel mondial, dacă aveți nevoie de coduri QR disponibile în China, vă rugăm să ne contactați. Putem face, de asemenea, cod QR personalizat pentru plăți mobile.

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

Documentație

Consultați acest video de pe YouTube despre cum se utilizează

Creați cod QR

1.

Mai întâi înregistrați-vă și obțineți Cheie API pentru a autoriza în Urmăriți datele --> Setările contului --> Cheie API

2.

Add this API key in every req (GET/POST) as Authorization: Bearer Cheie API

3. Generați un cod QR personalizat static
URL/api/qr/static
MetodePOST
AutorizareBearer API KEY
RăspunsBinary Image File (PNG, SVG)
Solicitare parametru
qrCategorystringurlQRCategory defininește diferite tipuri de QR, precum URL, vCard, Facebook, etc. Verificați mai jos tabelul QRCategory.
textStringhttps://qrcode-tiger.comAdresa URL de redirecționare dorită va fi încorporată în codul QR
sizenumber500Dimensiunea codului QR
logourlnullAdăugați orice URL logo pentru a activa logo-ul în centrul codului QR
colorDarkstring#5e0bf0Culoarea modelelor QR
backgroundColorString#ffffffCuloarea de fundal a codului QR (Notă: Alegeți întotdeauna o culoare intensă pentru un cod QR complet scanabil)
gradientBooleanfalseSetați „true” pentru a activa culoarea în degrade
grdTypeNumber0 (Left-to-Right)Verificați tabelul de mai jos pentru GRDType
color01String#5e0bf0Culoare degrade 1 a modelelor QR
color02String#f30505Culoare degrade 2 a modelelor QR
eye_colorBooleanfalseSetați „true” pentru a schimba culoarea ochilor
eye_color01String#5e0bf0Culoarea exterioară a ochiului
eye_color02String#f30505Culoarea interioară a ochiului
eye_outerStringeyeOuter0Design diferit al exteriorului ochiului, verificați tabelul de mai jos pentru toate modelele de design
eye_innerStringeyeInner0Design diferit al interiorului ochiului, verificați tabelul de mai jos pentru toate modelele de design
qrDataStringpattern0Diferite modele de date QR, verificați tabelul de mai jos pentru toate modelele
qrFormatStringpngDescărcați imaginea binară a fișierului de tip „png” sau „svg”
transparentBkgBooleanfalseDacă opțiunea este activată, codul QR va avea un fundal transparent
frameNumbernullDacă opțiunea este activată, codul QR va avea un cadru. Verificați tabelul de mai jos pentru modelele de cadre
frameColorStringnullCuloarea cadrului modifică culoarea textului din cadru
frameTextStringSCAN METextul cadrului afișat peste cadrul QR
Exemplu
URL/api/qr/static
MetodePOST
Parametru
{
  "size": 500,
  "colorDark": "rgb(5,64,128)",
  "logo": "scan_me.png",
  "eye_outer": "eyeOuter2",
  "eye_inner": "eyeInner1",
  "qrData": "pattern0",
  "backgroundColor": "rgb(255,255,255)",
  "transparentBkg": false,
  "qrCategory": "url",
  "text": "https://qrcode-tiger.com"
}
Răspuns
example 5
{
  "data": "base 64 QR image data",
  "url": "1601477992984.png"
}
4. Obțineți o listă cu toate campaniile QR din diferite categorii QR
URL/api/campaign/
MetodeGET
AutorizareBearer API KEY
RăspunsJSON object of QR list
GET /campaign/?page=1&limit=5&sort=1
Parametri de interogare
ParametruImplicitDescriere
page1numărul de pagini
limit5numărul de campanii pe pagină
sort1Sortează după dată (1) sau nume (2)
categoryurlcategoria definește diferite tipuri de coduri QR cum ar fi URL, vCard, Facebook, etc. Verificați mai jos tabelul QRCategory.
Exemplu
URL/api/campaign/?page=1&limit=5&sort=1&category=url
MetodeGET
Parametru
{
  "size": 500,
  "colorDark": "rgb(5,64,128)",
  "logo": "scan_me.png",
  "eye_outer": "eyeOuter2",
  "eye_inner": "eyeInner1",
  "qrData": "pattern0",
  "backgroundColor": "rgb(255,255,255)",
  "transparentBkg": false,
  "qrCategory": "url",
  "text": "https://qrcode-tiger.com"
}
Răspuns
{
  "query": {
    "limit": 1,
    "page": 1,
    "total": 146
  },
  "data": [
    {
      "scans": 0,
      "_id": "5f6f373a33320a0ca52581b0",
      "qrId": "HNXP",
      "qrType": "qr2",
      "qrCategory": "url",
      "shortUrl": "https://qrcode-tiger.com/HNXP",
      "redirectUrl": "https://www.qrcode-tiger.com/",
      "murlData": [],
      "qrName": "Campaign HNXP",
      "qrImage": "HNXP.png",
      "createdAt": "2020-09-26T12:42:34.070Z",
      "updatedAt": "2020-09-26T12:42:34.070Z",
      "user": null,
      "id": "5f6f373a33320a0ca52581b0"
    }
  ]
}
5. Generați un cod QR vizual personalizat dinamic
URL/api/campaign/
MetodePOST
AutorizareBearer API KEY
RăspunsBinary Image File (PNG, SVG)
Parametri de interogare
ParametruTipImplicitDescriere
qrUrlStringhttps://qrcode-tiger.comAdresa URL de redirecționare dorită va fi încorporată în codul dumneavoastră QR
qrTypeStringqr2QRType definește comportamentul QR, precum URL-ul unic de redirecționare sau URL-ul de redirecționare multiplă („qr2” sau „murl”)
qrCategoryStringurlQRCategory defininește diferite tipuri de QR, precum URL, vCard, Facebook, etc. Verificați mai jos tabelul QRCategory.
qr:JSON ObjectPersonalizați culoarea, modelele de date, ochii și nu numai ale codului dumneavoastră QR în cadrul acestui obiect
sizeNumber500Dimensiunea codului QR
logoString (url)nullAdăugați orice URL logo pentru a activa logo-ul în centrul codului QR
colorDarkString#5e0bf0Culoarea modelelor QR
backgroundColorString#ffffffCuloarea de fundal a codului QR (Notă: Alegeți întotdeauna o culoare intensă pentru un cod QR complet scanabil)
gradientBooleanfalseSetați „true” pentru a activa culoarea în degrade
grdTypeNumber0 (Left-to-Right)Verificați tabelul de mai jos pentru GRDType
color01String#5e0bf0Culoare degrade 1 a modelelor QR
color02String#f30505Culoare degrade 2 a modelelor QR
eye_colorBooleanfalseSetați „true” pentru a schimba culoarea ochilor
eye_color01String#5e0bf0Culoarea exterioară a ochiului
eye_color02String#f30505Culoarea interioară a ochiului
eye_outerStringeyeOuter0Design diferit al exteriorului ochiului, verificați tabelul de mai jos pentru toate modelele de design
eye_innerStringeyeInner0Design diferit al interiorului ochiului, verificați tabelul de mai jos pentru toate modelele de design
qrDataStringpattern0Diferite modele de date QR, verificați tabelul de mai jos pentru toate modelele
qrFormatStringpngDescărcați imaginea binară a fișierului de tip „png” sau „svg”
transparentBkgBooleanfalseDacă opțiunea este activată, codul QR va avea un fundal transparent
frameNumbernullDacă opțiunea este activată, codul QR va avea un cadru. Verificați tabelul de mai jos pentru modelele de cadre
frameColorStringnullCuloarea cadrului modifică culoarea textului din cadru
frameTextStringSCAN METextul cadrului afișat peste cadrul QR
Exemplu
URL/api/campaign
MetodePOST
Request Body
{
  "qr": {
    "size": 500,
    "colorDark": "rgb(5,64,128)",
    "logo": "1545827032075.png",
    "eye_outer": "eyeOuter2",
    "eye_inner": "eyeInner1",
    "qrData": "pattern0",
    "backgroundColor": "rgb(255,255,255)",
    "transparentBkg": false,
    "qrCategory": "url",
    "text": "https://www.qrcode-tiger.com.com/"
  },
  "murlData": [],
  "qrUrl": "https://www.qrcode-tiger.com.com",
  "qrType": "qr2",
  "qrCategory": "url",
  "qrId": "MP72"
}
Request Body
example 5
grdType (Default 0)
ParametruTipValoareDescriere
Stânga - DreaptaStringlinearDebit degrade de la stânga la dreapta
Sus - JosStringupDownFlux degrade de sus în jos
NV - SEStringdiagonal1Flux degrade pe diagonală în jos
SV - NEStringdiagonal2Flux degrade pe diagonală în sus
RadialStringradialFlux degrade Radial
eye_outer (Default 0)
ParametruTipValoareDescriere
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eye_inner
ParametruTipValoareDescriere
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
QrData
ParametruTipValoareDescriere
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
pattern11
Frame (Default : null)
ParametruTipValoareDescriere
frameNumber1
2
3
5. Urmăriți datele QR, numărul de scanări, țara, orașul, tipul dispozitivului
URL/data/qrid?period=month&tz=Asia/Singapore
MetodeGET
AutorizareBearer API KEY
RăspunsJSON object of track data
Solicitare parametru
ParametruTipDescriere
qrIdparamsId unic al codului QR
periodquery
„zi” (Datele zilei curente)
"săptămână" (Datele săptămânii curente)
„lună” (Datele lunii curente)
„luni” (Datele anului curent)
„an” (Date anuale)
tzqueryImplicit Asia/Singapore
Response
{
  "data": {
    "campaign": {
      "scanLoop": false,
      "bulk": false,
      "scans": 5,
      "scanCounter": 0,
      "_id": "5f297b7b88c80a7e70afbbc5",
      "qrId": "BXFO",
      "qrType": "qr2",
      "qrCategory": "url",
      "shortUrl": "https://qrcode-tiger.com/BXFO",
      "redirectUrl": "http://hello.com.vn",
      "murlData": [],
      "qrName": "Campaign BXFO",
      "qrImage": "BXFO.png",
      "owner": "5a84402c08004f37a2b87831",
      "scanData": [],
      "createdAt": "2020-08-04T15:15:07.057Z",
      "updatedAt": "2020-08-29T00:39:47.416Z",
      "__v": 0,
      "user": null,
      "id": "5f297b7b88c80a7e70afbbc5"
    },
    "city": [
      {
        "_id": {
          "city": "New York"
        },
        "count": 3
      },
      {
        "_id": {
          "city": "Ho Chi Minh City"
        },
        "count": 2
      }
    ],
    "data": [
      {
        "_id": {
          "device": "iOS",
          "loc": "VN",
          "city": "Ho Chi Minh City"
        },
        "count": 1
      },
      {
        "_id": {
          "device": null,
          "loc": "NY",
          "city": "New York"
        },
        "count": 3
      },
      {
        "_id": {
          "device": null,
          "loc": "VN",
          "city": "Ho Chi Minh City"
        },
        "count": 1
      }
    ],
    "country": [
      {
        "_id": {
          "loc": "VN"
        },
        "count": 2
      },
      {
        "_id": {
          "loc": "NY"
        },
        "count": 3
      }
    ],
    "device": [
      {
        "_id": {
          "device": "Android"
        },
        "count": 4
      },
      {
        "_id": {
          "device": "iOS"
        },
        "count": 1
      }
    ],
    "scans": 5,
    "unique": {
      "label": [
        {
          "month": "Aug",
          "year": 2020
        }
      ],
      "scans": [
        2
      ]
    },
    "graph": {
      "label": [
        {
          "month": "Aug",
          "year": 2020
        }
      ],
      "scans": [
        5
      ]
    }
  }
}
6. Încărcați logo-ul dumneavoastră
URL/accounts/uploads/
MetodePOST
Content-Typemultipart/form-data
Form-FieldFile
ResponseImage file url {“qrUrl”: 1526460566643.png}