QRTIGER API Dokumentation

Vores brugerdefinerede API for QR-koder tilbyder en professionel løsning til mærker der har behov for tilpassede QR-kodeskabeloner med datasporingssystem, dynamiske QR-koder, eller QR-koder i massevis og muligheden for at få QR-koder integreret i deres CRM.

Vores API er tilgængelig på "Mashape" og for alle andre spørgsmål kan du altid "kontakte os". Vores API kan bruges i hele verden. Hvis du har brug for dine QR-koder i Kina, bedes du kontakte os. Vi kan også lave tilpassede QR-koder til mobilbetalinger.

qrid:
example 1
example 2
example 3
example 4
example 5

Dokumentation

Se denne YouTube video om hvordan du bruger den

Opret QR-kode

1.

Log først ind og få API-nøgle at give tilladelse til Spor data --> Kontoindstillinger --> API-nøgle

2.

Add this API key in every req (GET/POST) as Authorization: Bearer API-nøgle

3. Generer Statisk brugerdefineret QR-kode
URL/api/qr/static
MetoderPOST
GodkendelseBearer API KEY
SvarBinary Image File (PNG, SVG)
Anmodningsparameter
qrCategorystringurlqrCategory definerer forskellige typer QR som url, vCard, Facebook osv. Tjek nedenstående qrCategory tabel.
textStringhttps://qrcode-tiger.comDin ønskede omdirigerings URL-adresse vil blive integreret i QR
sizenumber500Størrelse på QR
logourlnullTilføj et hvilket som helst logo url for at aktivere logoet i midten af QR
colorDarkstring#5e0bf0Farven på QR mønstrene
backgroundColorString#ffffffBaggrundsfarve for QR. (Bemærk: Vælg altid en lys farve for at få en QR, der kan scannes helt)
gradientBooleanfalseSæt til "sand" for at aktivere gradientfarve
grdTypeNumber0 (Left-to-Right)Tjek nedenstående tabel for grdType
color01String#5e0bf0Gradientfarve 1 på QR mønstre
color02String#f30505Gradientfarve 2 på QR mønstre
eye_colorBooleanfalseSæt til "sandt" for at ændre øjenfarven
eye_color01String#5e0bf0Farven på det ydre øje
eye_color02String#f30505Farven på det indre øje
eye_outerStringeyeOuter0Forskelligt design af ydre øje, tjek nedenstående tabel for alle designmønstre
eye_innerStringeyeInner0Forskelligt design af indre øje, tjek nedenstående tabel for alle designmønstre
qrDataStringpattern0Forskellige designs af qr datamønstre, tjek nedenstående tabel for alle designmønstre
qrFormatStringpngDownload binær billedfil af typen "png"eller "svg"
transparentBkgBooleanfalseHvis aktiveret vil QR-koden have gennemsigtig baggrund
frameNumbernullHvis aktiveret, vil QR have en ramme. Tjek nedenstående tabel for design for rammerne
frameColorStringnullRammefarve skift farven på rammeteksten
frameTextStringSCAN MERammetekst vist over QR rammen
Eksempel
URL/api/qr/static
MetoderPOST
Parameter
{
  "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"
}
Svar
example 5
{
  "data": "base 64 QR image data",
  "url": "1601477992984.png"
}
4. Få en liste over alle QR-kampagner i de forskellige QR-kategorier
URL/api/campaign/
MetoderGET
GodkendelseBearer API KEY
SvarJSON object of QR list
GET /campaign/?page=1&limit=5&sort=1
Forespørgselsparametre
ParameterStandardBeskrivelse
page1antal sider
limit5antal kampagner pr. side
sort1Sorter efter Dato(1) eller Navn(2)
categoryurlkategori definerer forskellige typer QR som url, vCard, Facebook, osv. Tjek qrCategory tabellen nedenfor.
Eksempel
URL/api/campaign/?page=1&limit=5&sort=1&category=url
MetoderGET
Parameter
{
  "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"
}
Svar
{
  "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. Generer en Dynamisk tilpasset Visuel QR-kode
URL/api/campaign/
MetoderPOST
GodkendelseBearer API KEY
SvarBinary Image File (PNG, SVG)
Forespørgselsparametre
ParameterTypeStandardBeskrivelse
qrUrlStringhttps://qrcode-tiger.comDin ønskede omdirigerings URL-adresse vil blive indlejret i QR
qrTypeStringqr2qrType definerer adfærd for qr, som et enkelt omdirigeret url, eller multi omdirigeret url ("qr2" eller "murl")
qrCategoryStringurlqrCategory definerer forskellige typer QR som url, vCard, Facebook osv. Tjek nedenstående qrCategory tabel.
qr:JSON ObjectDesign din QR-kode med farve, datamønstre, øjne og mere for dette objekt
sizeNumber500Størrelse på QR
logoString (url)nullTilføj et hvilket som helst logo url for at aktivere logoet i midten af QR
colorDarkString#5e0bf0Farven på QR mønstrene
backgroundColorString#ffffffBaggrundsfarve for QR. (Bemærk: Vælg altid en lys farve for at få en QR, der kan scannes helt)
gradientBooleanfalseSæt til "sand" for at aktivere gradientfarve
grdTypeNumber0 (Left-to-Right)Tjek nedenstående tabel for grdType
color01String#5e0bf0Gradientfarve 1 på QR mønstre
color02String#f30505Gradientfarve 2 på QR mønstre
eye_colorBooleanfalseSæt til "sandt" for at ændre øjenfarven
eye_color01String#5e0bf0Farven på det ydre øje
eye_color02String#f30505Farven på det indre øje
eye_outerStringeyeOuter0Forskelligt design af ydre øje, tjek nedenstående tabel for alle designmønstre
eye_innerStringeyeInner0Forskelligt design af indre øje, tjek nedenstående tabel for alle designmønstre
qrDataStringpattern0Forskellige designs af qr datamønstre, tjek nedenstående tabel for alle designmønstre
qrFormatStringpngDownload binær billedfil af typen "png"eller "svg"
transparentBkgBooleanfalseHvis aktiveret vil QR-koden have gennemsigtig baggrund
frameNumbernullHvis aktiveret, vil QR have en ramme. Tjek nedenstående tabel for design for rammerne
frameColorStringnullRammefarve skift farven på rammeteksten
frameTextStringSCAN MERammetekst vist over QR rammen
Eksempel
URL/api/campaign
MetoderPOST
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)
ParameterTypeVærdiBeskrivelse
Venstre - HøjreStringlinearGradient retning fra venstre mod højre
Top - BundStringupDownGradient retning fra Top til Bund
NV - SØStringdiagonal1Gradient med retning diagonalt nedad
SV - NØStringdiagonal2Gradient med retning diagonalt opad
RadialStringradialRadial gradient retning
eye_outer (Default 0)
ParameterTypeVærdiBeskrivelse
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eye_inner
ParameterTypeVærdiBeskrivelse
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
QrData
ParameterTypeVærdiBeskrivelse
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
pattern11
Frame (Default : null)
ParameterTypeVærdiBeskrivelse
frameNumber1
2
3
5. Spor dine QR-data, Antal scanninger, Land, By, Enhedstype
URL/data/qrid?period=month&tz=Asia/Singapore
MetoderGET
GodkendelseBearer API KEY
SvarJSON object of track data
Anmodningsparameter
ParameterTypeBeskrivelse
qrIdparamsUnikt id for qr
periodquery
"dag" (Data for den aktuelle dag)
"uge" (Data for den aktuelle uge)
"måned" (Data for den aktuelle måned)
"måneder" (Data for nuværende år)
"år" (Årlige data)
tzqueryStandard Asien/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. Upload dit logo
URL/accounts/uploads/
MetoderPOST
Content-Typemultipart/form-data
Form-FieldFile
ResponseImage file url {“qrUrl”: 1526460566643.png}