QRTIGER APIs Docs
Ons persoonlike QR-kode API bied 'n professionele oplossing vir handelsmerke wat persoonlike QR-kode sjablone met data-opsporingstelsel, dinamiese qr-kodes of qr-kodes in grootmaat moet hê en qr-kodes in hul CRM geïntegreer moet hê.
Ons API en is beskikbaar op 'Mashape' en vir enige ander vrae kan jy altyd 'Ons kontak'. Ons API kan wêreldwyd gebruik word, as jy jou QR-kodes in China beskikbaar soek, kontak ons asseblief. Ons kan ook persoonlike QR-kodes vir jou mobiele betalings voorsien.
qrId:
Dokumentasie
Kyk na hierdie YouTube-video oor hoe om dit te gebruik
Skep QR-kode
1.Meld eers aan en kry die API sleutel om te magtig in Volg data --> Rekening instelling --> API sleutel
Meld eers aan en kry die API sleutel om te magtig in Volg data --> Rekening instelling --> API sleutel
2.Add this API key in every req (GET/POST) as Authorization: Bearer API sleutel
Add this API key in every req (GET/POST) as Authorization: Bearer API sleutel
3. Genereer Statiese persoonlike QR-kode
URL | /api/qr/static |
Metodes | POST |
Magtiging | Bearer API KEY |
Reaksie | Binary Image File (PNG, SVG) |
Versoek parameter
qrCategory | string | url | qrkategorie definieer verskillende tipe qr soos url, Vcard, Facebook, ens. Kyk hier onder na die qrKategorie tabel. |
text | String | https://qrcode-tiger.com | Jou gewenste URL herleiding sal in QR ingebed word |
size | number | 500 | Grootte van die qr |
logo | url | null | Voeg enige logo url by om die logo in die middel van die QR te aktiveer |
colorDark | string | #5e0bf0 | Kleur van die qr-patrone |
backgroundColor | String | #ffffff | Agtergrond kleur van die QR. (Let wel: Kies altyd helder kleur 'n volledig skandeerbare QR) |
gradient | Boolean | false | Stel "waar" in om gradiënt kleur te aktiveer |
grdType | Number | 0 (Left-to-Right) | Kyk na die onderstaande tabel vir grdType |
color01 | String | #5e0bf0 | Gradiënt kleur 1 van qr-patrone |
color02 | String | #f30505 | Gradiënt kleur 2 van qr-patrone |
eye_color | Boolean | false | Stel "waar" in om die oogkleur te verander |
eye_color01 | String | #5e0bf0 | Kleur van die buitenste oog |
eye_color02 | String | #f30505 | kleur van die binneste oog |
eye_outer | String | eyeOuter0 | Verskillende ontwerp van buitenste oog, kyk na die tabel hieronder vir alle ontwerp patrone |
eye_inner | String | eyeInner0 | Verskillende ontwerp van binneste oog, kyk na die tabel hieronder vir alle ontwerp patrone |
qrData | String | pattern0 | Verskillende ontwerp van qr-data patrone, kyk na die onderstaande tabel vir alle ontwerp patrone |
qrFormat | String | png | Laai binêre beeldlêertipe "png" of "svg" af |
transparentBkg | Boolean | false | Indien geaktiveer, sal die QR-agtergrond deursigtig wees |
frame | Number | null | Indien geaktiveer, sal QR 'n raam hê. Kontroleer die tabel hieronder vir raam ontwerpe |
frameColor | String | null | Raam kleur verander die kleur van raam teks |
frameText | String | SCAN ME | Raamteks wat oor QR-raam gewys word |
Voorbeeld
URL | /api/qr/static |
Metodes | POST |
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" } |
Reaksie | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Ontvang 'n lys van alle QR-veldtogte van verskillende QR-kategorieë
URL | /api/campaign/ |
Metodes | GET |
Magtiging | Bearer API KEY |
Reaksie | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Navraag parameters
Parameter | Verstek | Beskrywing |
---|---|---|
page | 1 | No. van bladsy |
limit | 5 | Hoeveelheid veldtogte per bladsy |
sort | 1 | Sorteer volgens Datum(1) of Naam(2) |
category | url | kategorie definieer verskillende tipe qr soos url, Vcard, Facebook, ens. Kyk hieronder na die qrkategorie tabel. |
Voorbeeld
URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
Metodes | GET |
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" } |
Reaksie | { "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. Genereer 'n Dinamiese persoonlike Visuele QR-kode
URL | /api/campaign/ |
Metodes | POST |
Magtiging | Bearer API KEY |
Reaksie | Binary Image File (PNG, SVG) |
Navraag parameters
Parameter | Tipe | Verstek | Beskrywing | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Jou gewenste URL herleiding sal in QR ingebed word | |
qrType | String | qr2 | qrTipe definieer die gedrag van die qr soos enkelherleiding url of multi-herleiding url ("qr2" of "murl") | |
qrCategory | String | url | qrkategorie definieer verskillende tipe qr soos url, Vcard, Facebook, ens. Kyk hier onder na die qrKategorie tabel. | |
qr: | JSON Object | Ontwerp jou qr-kode soos kleur, data patrone, oë, ens binne hierdie voorwerp | ||
size | Number | 500 | Grootte van die qr | |
logo | String (url) | null | Voeg enige logo url by om die logo in die middel van die QR te aktiveer | |
colorDark | String | #5e0bf0 | Kleur van die qr-patrone | |
backgroundColor | String | #ffffff | Agtergrond kleur van die QR. (Let wel: Kies altyd helder kleur 'n volledig skandeerbare QR) | |
gradient | Boolean | false | Stel "waar" in om gradiënt kleur te aktiveer | |
grdType | Number | 0 (Left-to-Right) | Kyk na die onderstaande tabel vir grdType | |
color01 | String | #5e0bf0 | Gradiënt kleur 1 van qr-patrone | |
color02 | String | #f30505 | Gradiënt kleur 2 van qr-patrone | |
eye_color | Boolean | false | Stel "waar" in om die oogkleur te verander | |
eye_color01 | String | #5e0bf0 | Kleur van die buitenste oog | |
eye_color02 | String | #f30505 | kleur van die binneste oog | |
eye_outer | String | eyeOuter0 | Verskillende ontwerp van buitenste oog, kyk na die tabel hieronder vir alle ontwerp patrone | |
eye_inner | String | eyeInner0 | Verskillende ontwerp van binneste oog, kyk na die tabel hieronder vir alle ontwerp patrone | |
qrData | String | pattern0 | Verskillende ontwerp van qr-data patrone, kyk na die onderstaande tabel vir alle ontwerp patrone | |
qrFormat | String | png | Laai binêre beeldlêertipe "png" of "svg" af | |
transparentBkg | Boolean | false | Indien geaktiveer, sal die QR-agtergrond deursigtig wees | |
frame | Number | null | Indien geaktiveer, sal QR 'n raam hê. Kontroleer die tabel hieronder vir raam ontwerpe | |
frameColor | String | null | Raam kleur verander die kleur van raam teks | |
frameText | String | SCAN ME | Raamteks wat oor QR-raam gewys word |
Voorbeeld
URL | /api/campaign |
Metodes | POST |
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 |
grdType (Default 0)
Parameter | Tipe | Waarde | Beskrywing |
---|---|---|---|
Links - Regs | String | linear | Gradiënt vloei van links na regs |
Bokant - Onderkant | String | upDown | Gradiënt vloei van Bo na Onder |
NW - SE | String | diagonal1 | Gradiënt vloei skuins afwaarts |
SW - NO | String | diagonal2 | Gradiënt vloei skuins opwaarts |
Radiaal | String | radial | Gradiënt vloei Radiaal |
eye_outer (Default 0)
Parameter | Tipe | Waarde | Beskrywing |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Parameter | Tipe | Waarde | Beskrywing |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Parameter | Tipe | Waarde | Beskrywing |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Parameter | Tipe | Waarde | Beskrywing |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Volg jou QR-data, aantal Skanderings, Land, Stad, Tipe toestel
URL | /data/qrid?period=month&tz=Asia/Singapore |
Metodes | GET |
Magtiging | Bearer API KEY |
Reaksie | JSON object of track data |
Versoek parameter
Parameter | Tipe | Beskrywing |
---|---|---|
qrId | params | Unieke ID van die qr |
period | query | "dag" (Data van huidige dag) "week" (Data van die huidige week) “maand” (Data van die huidige maand) "maande" (Data van die huidige jaar) "jaar" (Jaarlikse data) |
tz | query | Verstek Asië/Singapoer |
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. Laai jou logo op
URL | /accounts/uploads/ |
Metodes | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |