Dokumen API QRTIGER
API kod qr tersuai kami menawarkan penyelesaian profesional untuk jenama yang perlu mempunyai templat kod qr tersuai dengan sistem penjejakan data, kod qr dinamik atau kod qr secara pukal dan mempunyai kod qr disepadukan dalam CRM mereka.
API kami dan boleh didapati di 'Mashape' untuk sebarang soalan lain anda sentiasa boleh 'hubungi kami' API kami boleh digunakan di seluruh dunia, jika anda memerlukan kod QR anda tersedia di China, sila hubungi kami. Kami juga boleh melakukan kod QR yang disesuaikan untuk pembayaran mudah alih.
qrId:
Dokumentasi
Semak video YouTube ini cara menggunakannya
Cipta Kod QR
1.Log masuk pertama dan dapatkan Kunci API untuk membenarkan Jejaki Data --> Tetapan akaun --> Kunci API
Log masuk pertama dan dapatkan Kunci API untuk membenarkan Jejaki Data --> Tetapan akaun --> 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. Hasilkan kod QR tersuai Statik
URL | /api/qr/static |
Kaedah | POST |
Kebenaran | Bearer API KEY |
Respon | Binary Image File (PNG, SVG) |
Parameter permintaan
qrCategory | string | url | qrCategory mentakrifkan jenis qr yang berbeza seperti url, Vcard, facebook, dll. Semak di bawah jadual qrCategory. |
text | String | https://qrcode-tiger.com | URL pengalihan yang anda inginkan akan dibenamkan dalam QR |
size | number | 500 | Saiz qr |
logo | url | null | Tambahkan sebarang url logo untuk mendayakan logo di tengah qr |
colorDark | string | #5e0bf0 | Warna corak qr |
backgroundColor | String | #ffffff | Warna latar belakang QR. (Nota: Sentiasa pilih warna terang untuk QR yang boleh diimbas sepenuhnya) |
gradient | Boolean | false | Tetapkan "benar" untuk mendayakan warna kecerunan |
grdType | Number | 0 (Left-to-Right) | Semak jadual di bawah untuk grdType |
color01 | String | #5e0bf0 | Warna kecerunan 1 corak qr |
color02 | String | #f30505 | Warna kecerunan 2 corak qr |
eye_color | Boolean | false | Tetapkan "benar" untuk menukar warna mata |
eye_color01 | String | #5e0bf0 | Warna mata luar |
eye_color02 | String | #f30505 | warna mata dalam |
eye_outer | String | eyeOuter0 | Reka bentuk mata luar yang berbeza, semak jadual di bawah untuk semua corak reka bentuk |
eye_inner | String | eyeInner0 | Reka bentuk mata dalam yang berbeza, semak jadual di bawah untuk semua corak reka bentuk |
qrData | String | pattern0 | Reka bentuk corak data qr yang berbeza, semak jadual di bawah untuk semua corak reka bentuk |
qrFormat | String | png | Muat turun jenis fail imej binari "png" atau "svg" |
transparentBkg | Boolean | false | Sekiranya diaktifkan, kod QR akan mempunyai latar belakang yang telus |
frame | Number | null | Jika dayakan qr terdiri daripada bingkai. semak jadual di bawah untuk Reka bentuk bingkai |
frameColor | String | null | Warna bingkai menukar warna teks bingkai |
frameText | String | SCAN ME | Teks bingkai ditunjukkan pada bingkai QR |
Contoh
URL | /api/qr/static |
Kaedah | 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" } |
Respon | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Dapatkan senarai semua kempen QR kategori qr berbeza
URL | /api/campaign/ |
Kaedah | GET |
Kebenaran | Bearer API KEY |
Respon | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Parameter pertanyaan
Parameter | Lalai | Penerangan |
---|---|---|
page | 1 | tidak. daripada halaman |
limit | 5 | bil. kempen setiap halaman |
sort | 1 | Isih mengikut Tarikh(1) atau Nama(2) |
category | url | kategori menentukan jenis qr yang berbeza seperti url, Vcard, facebook, dll. Semak di bawah jadual qrCategory. |
Contoh
URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
Kaedah | 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" } |
Respon | { "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. Hasilkan kod QR Visual tersuai Dinamik
URL | /api/campaign/ |
Kaedah | POST |
Kebenaran | Bearer API KEY |
Respon | Binary Image File (PNG, SVG) |
Parameter pertanyaan
Parameter | taip | Lalai | Penerangan | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Url ubah hala yang dikehendaki anda akan dibenamkan dalam QR | |
qrType | String | qr2 | qrType mentakrifkan kelakuan qr seperti url ubah hala tunggal atau url berbilang ubah hala (“qr2” atau “murl”) | |
qrCategory | String | url | qrCategory mentakrifkan jenis qr yang berbeza seperti url, Vcard, facebook, dll. Semak di bawah jadual qrCategory. | |
qr: | JSON Object | Reka kod qr anda seperti warna, corak data, mata dll dalam objek ini | ||
size | Number | 500 | Saiz qr | |
logo | String (url) | null | Tambahkan sebarang url logo untuk mendayakan logo di tengah qr | |
colorDark | String | #5e0bf0 | Warna corak qr | |
backgroundColor | String | #ffffff | Warna latar belakang QR. (Nota: Sentiasa pilih warna terang untuk QR yang boleh diimbas sepenuhnya) | |
gradient | Boolean | false | Tetapkan "benar" untuk mendayakan warna kecerunan | |
grdType | Number | 0 (Left-to-Right) | Semak jadual di bawah untuk grdType | |
color01 | String | #5e0bf0 | Warna kecerunan 1 corak qr | |
color02 | String | #f30505 | Warna kecerunan 2 corak qr | |
eye_color | Boolean | false | Tetapkan "benar" untuk menukar warna mata | |
eye_color01 | String | #5e0bf0 | Warna mata luar | |
eye_color02 | String | #f30505 | warna mata dalam | |
eye_outer | String | eyeOuter0 | Reka bentuk mata luar yang berbeza, semak jadual di bawah untuk semua corak reka bentuk | |
eye_inner | String | eyeInner0 | Reka bentuk mata dalam yang berbeza, semak jadual di bawah untuk semua corak reka bentuk | |
qrData | String | pattern0 | Reka bentuk corak data qr yang berbeza, semak jadual di bawah untuk semua corak reka bentuk | |
qrFormat | String | png | Muat turun jenis fail imej binari "png" atau "svg" | |
transparentBkg | Boolean | false | Sekiranya diaktifkan, kod QR akan mempunyai latar belakang yang telus | |
frame | Number | null | Jika dayakan qr terdiri daripada bingkai. semak jadual di bawah untuk Reka bentuk bingkai | |
frameColor | String | null | Warna bingkai menukar warna teks bingkai | |
frameText | String | SCAN ME | Teks bingkai ditunjukkan pada bingkai QR |
Contoh
URL | /api/campaign |
Kaedah | 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 | taip | Nilai | Penerangan |
---|---|---|---|
Kiri kanan | String | linear | Aliran kecerunan kiri ke kanan |
Atas - Bawah | String | upDown | Aliran Gradient Atas ke Bawah |
NW - SE | String | diagonal1 | Aliran kecerunan menyerong ke bawah |
SW - NE | String | diagonal2 | Aliran kecerunan menyerong ke atas |
Jejari | String | radial | Aliran kecerunan secara jejari |
eye_outer (Default 0)
Parameter | taip | Nilai | Penerangan |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Parameter | taip | Nilai | Penerangan |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Parameter | taip | Nilai | Penerangan |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Parameter | taip | Nilai | Penerangan |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Jejaki Data QR anda, Bilangan imbasan, Negara, Bandar, Jenis peranti
URL | /data/qrid?period=month&tz=Asia/Singapore |
Kaedah | GET |
Kebenaran | Bearer API KEY |
Respon | JSON object of track data |
Parameter permintaan
Parameter | taip | Penerangan |
---|---|---|
qrId | params | Id unik qr |
period | query | “hari” (Hari iaitu data hari semasa/ hari ini) "minggu" (Data minggu semasa) “bulan” (Data bulan semasa) "bulan" (Bulan iaitu data tahun semasa) “tahun” (data tahunan) |
tz | query | Lalai 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. Muat naik logo anda
URL | /accounts/uploads/ |
Kaedah | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |