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:
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
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
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 |
Metode | POST |
Autorizare | Bearer API KEY |
Răspuns | Binary Image File (PNG, SVG) |
Solicitare parametru
qrCategory | string | url | QRCategory defininește diferite tipuri de QR, precum URL, vCard, Facebook, etc. Verificați mai jos tabelul QRCategory. |
text | String | https://qrcode-tiger.com | Adresa URL de redirecționare dorită va fi încorporată în codul QR |
size | number | 500 | Dimensiunea codului QR |
logo | url | null | Adăugați orice URL logo pentru a activa logo-ul în centrul codului QR |
colorDark | string | #5e0bf0 | Culoarea modelelor QR |
backgroundColor | String | #ffffff | Culoarea de fundal a codului QR (Notă: Alegeți întotdeauna o culoare intensă pentru un cod QR complet scanabil) |
gradient | Boolean | false | Setați „true” pentru a activa culoarea în degrade |
grdType | Number | 0 (Left-to-Right) | Verificați tabelul de mai jos pentru GRDType |
color01 | String | #5e0bf0 | Culoare degrade 1 a modelelor QR |
color02 | String | #f30505 | Culoare degrade 2 a modelelor QR |
eye_color | Boolean | false | Setați „true” pentru a schimba culoarea ochilor |
eye_color01 | String | #5e0bf0 | Culoarea exterioară a ochiului |
eye_color02 | String | #f30505 | Culoarea interioară a ochiului |
eye_outer | String | eyeOuter0 | Design diferit al exteriorului ochiului, verificați tabelul de mai jos pentru toate modelele de design |
eye_inner | String | eyeInner0 | Design diferit al interiorului ochiului, verificați tabelul de mai jos pentru toate modelele de design |
qrData | String | pattern0 | Diferite modele de date QR, verificați tabelul de mai jos pentru toate modelele |
qrFormat | String | png | Descărcați imaginea binară a fișierului de tip „png” sau „svg” |
transparentBkg | Boolean | false | Dacă opțiunea este activată, codul QR va avea un fundal transparent |
frame | Number | null | Dacă opțiunea este activată, codul QR va avea un cadru. Verificați tabelul de mai jos pentru modelele de cadre |
frameColor | String | null | Culoarea cadrului modifică culoarea textului din cadru |
frameText | String | SCAN ME | Textul cadrului afișat peste cadrul QR |
Exemplu
URL | /api/qr/static |
Metode | POST |
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 | { "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/ |
Metode | GET |
Autorizare | Bearer API KEY |
Răspuns | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Parametri de interogare
Parametru | Implicit | Descriere |
---|---|---|
page | 1 | numărul de pagini |
limit | 5 | numărul de campanii pe pagină |
sort | 1 | Sortează după dată (1) sau nume (2) |
category | url | categoria 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 |
Metode | GET |
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/ |
Metode | POST |
Autorizare | Bearer API KEY |
Răspuns | Binary Image File (PNG, SVG) |
Parametri de interogare
Parametru | Tip | Implicit | Descriere | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Adresa URL de redirecționare dorită va fi încorporată în codul dumneavoastră QR | |
qrType | String | qr2 | QRType definește comportamentul QR, precum URL-ul unic de redirecționare sau URL-ul de redirecționare multiplă („qr2” sau „murl”) | |
qrCategory | String | url | QRCategory defininește diferite tipuri de QR, precum URL, vCard, Facebook, etc. Verificați mai jos tabelul QRCategory. | |
qr: | JSON Object | Personalizați culoarea, modelele de date, ochii și nu numai ale codului dumneavoastră QR în cadrul acestui obiect | ||
size | Number | 500 | Dimensiunea codului QR | |
logo | String (url) | null | Adăugați orice URL logo pentru a activa logo-ul în centrul codului QR | |
colorDark | String | #5e0bf0 | Culoarea modelelor QR | |
backgroundColor | String | #ffffff | Culoarea de fundal a codului QR (Notă: Alegeți întotdeauna o culoare intensă pentru un cod QR complet scanabil) | |
gradient | Boolean | false | Setați „true” pentru a activa culoarea în degrade | |
grdType | Number | 0 (Left-to-Right) | Verificați tabelul de mai jos pentru GRDType | |
color01 | String | #5e0bf0 | Culoare degrade 1 a modelelor QR | |
color02 | String | #f30505 | Culoare degrade 2 a modelelor QR | |
eye_color | Boolean | false | Setați „true” pentru a schimba culoarea ochilor | |
eye_color01 | String | #5e0bf0 | Culoarea exterioară a ochiului | |
eye_color02 | String | #f30505 | Culoarea interioară a ochiului | |
eye_outer | String | eyeOuter0 | Design diferit al exteriorului ochiului, verificați tabelul de mai jos pentru toate modelele de design | |
eye_inner | String | eyeInner0 | Design diferit al interiorului ochiului, verificați tabelul de mai jos pentru toate modelele de design | |
qrData | String | pattern0 | Diferite modele de date QR, verificați tabelul de mai jos pentru toate modelele | |
qrFormat | String | png | Descărcați imaginea binară a fișierului de tip „png” sau „svg” | |
transparentBkg | Boolean | false | Dacă opțiunea este activată, codul QR va avea un fundal transparent | |
frame | Number | null | Dacă opțiunea este activată, codul QR va avea un cadru. Verificați tabelul de mai jos pentru modelele de cadre | |
frameColor | String | null | Culoarea cadrului modifică culoarea textului din cadru | |
frameText | String | SCAN ME | Textul cadrului afișat peste cadrul QR |
Exemplu
URL | /api/campaign |
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)
Parametru | Tip | Valoare | Descriere |
---|---|---|---|
Stânga - Dreapta | String | linear | Debit degrade de la stânga la dreapta |
Sus - Jos | String | upDown | Flux degrade de sus în jos |
NV - SE | String | diagonal1 | Flux degrade pe diagonală în jos |
SV - NE | String | diagonal2 | Flux degrade pe diagonală în sus |
Radial | String | radial | Flux degrade Radial |
eye_outer (Default 0)
Parametru | Tip | Valoare | Descriere |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Parametru | Tip | Valoare | Descriere |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Parametru | Tip | Valoare | Descriere |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Parametru | Tip | Valoare | Descriere |
---|---|---|---|
frame | Number | 1 | |
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 |
Metode | GET |
Autorizare | Bearer API KEY |
Răspuns | JSON object of track data |
Solicitare parametru
Parametru | Tip | Descriere |
---|---|---|
qrId | params | Id unic al codului QR |
period | query | „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) |
tz | query | Implicit 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/ |
Metode | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |