QRTIGER APIs Docs
API kode qr khusus dhewek nawakake solusi profesional kanggo merek sing butuh duwe template kode qr khusus kanthi sistem pelacakan data, kode qr dinamis utawa kode qr massal lan duwe kode qr sing terintegrasi ing CRM.
API we'e dhewek lan kasedhiya ing "Mashape" kanggo pitakonan liyane sampeyan bisa tansah "hubungi dhewek" API we'e dhewek bisa digunakake ing saindhenging donya, yen sampeyan perlu kode QR kasedhiya ing China, hubungi dhewek. Dhewek uga bisa nindakake kode QR khusus kanggo pembayaran seluler.
qrId:
Dokumentasi
Priksa video YouTube iki carane nggunakake
Nggawe Kode QR
1.Mlebet pisanan lan entuk kunci API kanggo wewenang ing Lacak data --> Setelan akun --> kunci API
Mlebet pisanan lan entuk kunci API kanggo wewenang ing Lacak data --> Setelan akun --> kunci API
2.Add this API key in every req (GET/POST) as Authorization: Bearer kunci API
Add this API key in every req (GET/POST) as Authorization: Bearer kunci API
3. Ngasilake kode QR khusus statis
URL | /api/qr/static |
Metode-metode | POST |
Wewenang | Bearer API KEY |
Wangsulan | Binary Image File (PNG, SVG) |
Parameter panjaluk
qrCategory | string | url | qrCategory nemtokake macem-macem jinis qr kaya url, Vcard, facebook, dll. Priksa tabel qrCategory ing ngisor iki. |
text | String | https://qrcode-tiger.com | URL pangalihan sing dikarepake bakal diselehake ing QR |
size | number | 500 | Ukuran qr |
logo | url | null | Tambah url logo apa wae kanggo ngaktifake logo ing tengah QR |
colorDark | string | #5e0bf0 | Werna pola qr |
backgroundColor | String | #ffffff | Werna latar mburi QR. (Cathetan: Pilih warna sing padhang kanggo QR sing bisa dipindai kanthi lengkap) |
gradient | Boolean | false | Setel "bener" kanggo ngaktifake werna gradien |
grdType | Number | 0 (Left-to-Right) | Priksa tabel ing ngisor iki kanggo grdType |
color01 | String | #5e0bf0 | Werna gradien 1 saka pola qr |
color02 | String | #f30505 | Werna gradien 2 pola qr |
eye_color | Boolean | false | Setel "bener" kanggo ngganti werna mripat |
eye_color01 | String | #5e0bf0 | Werna mripat sing njaba |
eye_color02 | String | #f30505 | Werna mripat sing njero |
eye_outer | String | eyeOuter0 | Beda desain mripat sing njaba, ndelok tabel ing ngisor iki kanggo kabeh pola desain |
eye_inner | String | eyeInner0 | Beda desain sing saka mripat sing njero, ndelok tabel ing ngisor iki kanggo kabeh pola desain |
qrData | String | pattern0 | Beda Desain saka pola data qr, priksa tabel ing ngisor iki kanggo kabeh pola desain |
qrFormat | String | png | Unduh jinis berkas gambar binar "png" utawa "svg" |
transparentBkg | Boolean | false | Yen diaktifake, kode QR bakal duwe latar mburi transparan |
frame | Number | null | Yen diaktifake, QR bakal duwe pigura. Priksa tabel ing ngisor iki kanggo desain pigura |
frameColor | String | null | Werna pigura ngganti werna teks pigura |
frameText | String | SCAN ME | Teks pigura ditampilake liwat pigura QR |
Contho
URL | /api/qr/static |
Metode-metode | POST |
Paramèter | { "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" } |
Wangsulan | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Entuk dhaptar kabeh kampanye QR saka macem-macem kategori QR
URL | /api/campaign/ |
Metode-metode | GET |
Wewenang | Bearer API KEY |
Wangsulan | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Paramèter pitakon
Paramèter | Gawan | Katrangan |
---|---|---|
page | 1 | no. saka kaca |
limit | 5 | ora. kampanye saben kaca |
sort | 1 | Urut miturut Tanggal(1) utawa Jeneng(2) |
category | url | kategori nemtokake macem-macem jinis qr kaya url, Vcard, facebook, lan liya-liya. Priksa tabel qrCategory ning ngisor iki. |
Contho
URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
Metode-metode | GET |
Paramèter | { "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" } |
Wangsulan | { "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. Ngasilake kode QR Visual khusus Dinamis
URL | /api/campaign/ |
Metode-metode | POST |
Wewenang | Bearer API KEY |
Wangsulan | Binary Image File (PNG, SVG) |
Paramèter pitakon
Paramèter | Jinis | Gawan | Katrangan | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | URL pangalihan sing dikarepake bakal diselehake ing QR | |
qrType | String | qr2 | qrType nemtokake prilaku saka qr kaya url pangalihan siji utawa url multi pangalihan ("qr2" utawa "murl") | |
qrCategory | String | url | qrCategory nemtokake macem-macem jinis qr kaya url, Vcard, facebook, dll. Priksa tabel qrCategory ing ngisor iki. | |
qr: | JSON Object | Rancang kode qr sampeyan kaya warna, pola data, mata, lsp ing obyek iki | ||
size | Number | 500 | Ukuran qr | |
logo | String (url) | null | Tambah url logo apa wae kanggo ngaktifake logo ing tengah QR | |
colorDark | String | #5e0bf0 | Werna pola qr | |
backgroundColor | String | #ffffff | Werna latar mburi QR. (Cathetan: Pilih warna sing padhang kanggo QR sing bisa dipindai kanthi lengkap) | |
gradient | Boolean | false | Setel "bener" kanggo ngaktifake werna gradien | |
grdType | Number | 0 (Left-to-Right) | Priksa tabel ing ngisor iki kanggo grdType | |
color01 | String | #5e0bf0 | Werna gradien 1 saka pola qr | |
color02 | String | #f30505 | Werna gradien 2 pola qr | |
eye_color | Boolean | false | Setel "bener" kanggo ngganti werna mripat | |
eye_color01 | String | #5e0bf0 | Werna mripat sing njaba | |
eye_color02 | String | #f30505 | Werna mripat sing njero | |
eye_outer | String | eyeOuter0 | Beda desain mripat sing njaba, ndelok tabel ing ngisor iki kanggo kabeh pola desain | |
eye_inner | String | eyeInner0 | Beda desain sing saka mripat sing njero, ndelok tabel ing ngisor iki kanggo kabeh pola desain | |
qrData | String | pattern0 | Beda Desain saka pola data qr, priksa tabel ing ngisor iki kanggo kabeh pola desain | |
qrFormat | String | png | Unduh jinis berkas gambar binar "png" utawa "svg" | |
transparentBkg | Boolean | false | Yen diaktifake, kode QR bakal duwe latar mburi transparan | |
frame | Number | null | Yen diaktifake, QR bakal duwe pigura. Priksa tabel ing ngisor iki kanggo desain pigura | |
frameColor | String | null | Werna pigura ngganti werna teks pigura | |
frameText | String | SCAN ME | Teks pigura ditampilake liwat pigura QR |
Contho
URL | /api/campaign |
Metode-metode | 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)
Paramèter | Jinis | Nilai | Katrangan |
---|---|---|---|
Ngiwa - Tengen | String | linear | Aliran gradien ngiwa nengen |
Ndhuwur - Ngisor | String | upDown | Aliran gradien Ndhuwur nganti Ngisor |
NW - SE | String | diagonal1 | Aliran gradien Diagonal Mudhun |
SW-NE | String | diagonal2 | Aliran gradien diagonal munggah |
Radial | String | radial | Aliran gradien Radial |
eye_outer (Default 0)
Paramèter | Jinis | Nilai | Katrangan |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Paramèter | Jinis | Nilai | Katrangan |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Paramèter | Jinis | Nilai | Katrangan |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Paramèter | Jinis | Nilai | Katrangan |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Lacak Data QR sampeyan, Nomer scan, Negara, Kutha, Jinis piranti
URL | /data/qrid?period=month&tz=Asia/Singapore |
Metode-metode | GET |
Wewenang | Bearer API KEY |
Wangsulan | JSON object of track data |
Parameter panjaluk
Paramèter | Jinis | Katrangan |
---|---|---|
qrId | params | ID unik saka qr |
period | query | "dina" (Data dina saiki) "minggu" (Data minggu saiki) "wulan" (Data sasi saiki) "wulan" (Data taun saiki) "taun" (data taunan) |
tz | query | Bawaane Asia/Singapura |
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. Unggah logo sampeyan
URL | /accounts/uploads/ |
Metode-metode | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |