QRTIGER APIs Έγγραφα
Το προσαρμοσμένο Qr code API μας προσφέρει μια επαγγελματική λύση για επωνυμίες που πρέπει να διαθέτουν προσαρμοσμένα πρότυπα κώδικα qr με σύστημα παρακολούθησης δεδομένων, δυναμικούς κωδικούς qr ή κώδικες qr μαζικά και να έχουν ενσωματωμένους κωδικούς qr στο CRM τους.
Το API μας και είναι διαθέσιμο στο "Mashape" για οποιεσδήποτε άλλες ερωτήσεις μπορείτε πάντα να "επικοινωνήσετε μαζί μας" Το API μας μπορεί να χρησιμοποιηθεί παγκοσμίως. Εάν χρειάζεστε τους κωδικούς QR που διαθέτετε στην Κίνα, επικοινωνήστε μαζί μας. Μπορούμε επίσης να κάνουμε προσαρμοσμένο κωδικό QR για πληρωμές μέσω κινητού τηλεφώνου.
qrId:
Τεκμηρίωση
Ελέγξτε αυτό το βίντεο στο YouTube πώς να το χρησιμοποιήσετε
Δημιουργία κώδικα QR
1.Πρώτα συνδεθείτε και λάβετε το Κλειδί API να εξουσιοδοτήσει σε Δεδομένα παρακολούθησης --> Ρύθμιση λογαριασμού --> Κλειδί API
Πρώτα συνδεθείτε και λάβετε το Κλειδί API να εξουσιοδοτήσει σε Δεδομένα παρακολούθησης --> Ρύθμιση λογαριασμού --> Κλειδί API
2.Add this API key in every req (GET/POST) as Authorization: Bearer Κλειδί API
Add this API key in every req (GET/POST) as Authorization: Bearer Κλειδί API
3. Δημιουργία στατικού προσαρμοσμένου κωδικού QR
URL | /api/qr/static |
Μέθοδοι | POST |
Δικαίωμα πρόσβασης | Bearer API KEY |
Απάντηση | Binary Image File (PNG, SVG) |
Παράμετρος αίτησης
qrCategory | string | url | qrCategory ορίζουν διαφορετικούς τύπους qr όπως url, Vcard, facebook, κλπ. Ελέγξτε τον παρακάτω πίνακα qrCategory. |
text | String | https://qrcode-tiger.com | Η επιθυμητή διεύθυνση URL ανακατεύθυνσης θα ενσωματωθεί στο QR |
size | number | 500 | Μέγεθος του qr |
logo | url | null | Προσθέστε οποιοδήποτε url λογότυπο για να ενεργοποιήσετε το λογότυπο στο κέντρο του QR |
colorDark | string | #5e0bf0 | Χρώμα των μοτίβων qr |
backgroundColor | String | #ffffff | Χρώμα φόντου του QR. (Σημείωση: Επιλέγετε πάντα φωτεινό χρώμα για ένα πλήρως ανιχνεύσιμο QR) |
gradient | Boolean | false | Ορίστε "true" για να ενεργοποιήσετε το χρώμα διαβάθμισης |
grdType | Number | 0 (Left-to-Right) | Ελέγξτε τον παρακάτω πίνακα για το grdType |
color01 | String | #5e0bf0 | Χρώμα διαβάθμισης 1 των μοτίβων qr |
color02 | String | #f30505 | Χρώμα διαβάθμισης 2 των μοτίβων qr |
eye_color | Boolean | false | Ορίστε "true" για να αλλάξετε το χρώμα των ματιών |
eye_color01 | String | #5e0bf0 | Χρώμα του εξωτερικού ματιού |
eye_color02 | String | #f30505 | Χρώμα του εσωτερικού ματιού |
eye_outer | String | eyeOuter0 | Διαφορετικός σχεδιασμός του εξωτερικού ματιού, ελέγξτε τον παρακάτω πίνακα για όλα τα σχέδια σχεδιασμού |
eye_inner | String | eyeInner0 | Διαφορετικός σχεδιασμός του εσωτερικού ματιού, ελέγξτε τον παρακάτω πίνακα για όλα τα σχέδια σχεδιασμού |
qrData | String | pattern0 | Διαφορετικός σχεδιασμός προτύπων δεδομένων qr, ελέγξτε τον παρακάτω πίνακα για όλα τα πρότυπα σχεδιασμού |
qrFormat | String | png | Λήψη δυαδικού αρχείου εικόνας τύπου "png" ή "svg" |
transparentBkg | Boolean | false | Εάν είναι ενεργοποιημένο, ο κωδικός QR θα έχει διαφανές φόντο |
frame | Number | null | Εάν είναι ενεργοποιημένο, το QR θα έχει ένα πλαίσιο. Ελέγξτε τον παρακάτω πίνακα για τα σχέδια πλαισίων |
frameColor | String | null | Χρώμα πλαισίου αλλάξτε το χρώμα του κειμένου πλαισίου |
frameText | String | SCAN ME | Το κείμενο του πλαισίου εμφανίζεται πάνω από το πλαίσιο QR |
Παράδειγμα
URL | /api/qr/static |
Μέθοδοι | POST |
Παράμετρος | { "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" } |
Απάντηση | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Λάβετε μια λίστα με όλες τις καμπάνιες QR διαφόρων κατηγοριών QR
URL | /api/campaign/ |
Μέθοδοι | GET |
Δικαίωμα πρόσβασης | Bearer API KEY |
Απάντηση | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Παράμετροι αναζήτησης
Παράμετρος | Προκαθορισμένο | Περιγραφή: |
---|---|---|
page | 1 | αριθμός σελίδας |
limit | 5 | αριθμός εκστρατείας ανά σελίδα |
sort | 1 | Ταξινόμηση κατά ημερομηνία(1) ή όνομα(2) |
category | url | κατηγορία ορίζουν διαφορετικό τύπο qr όπως url, Vcard, facebook, κλπ. Ελέγξτε τον παρακάτω πίνακα qrCategory. |
Παράδειγμα
URL | /api/campaign/?page=1&limit=5&sort=1&category=url |
Μέθοδοι | GET |
Παράμετρος | { "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" } |
Απάντηση | { "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. Δημιουργία ενός δυναμικού προσαρμοσμένου οπτικού κώδικα QR
URL | /api/campaign/ |
Μέθοδοι | POST |
Δικαίωμα πρόσβασης | Bearer API KEY |
Απάντηση | Binary Image File (PNG, SVG) |
Παράμετροι αναζήτησης
Παράμετρος | Τύπος | Προκαθορισμένο | Περιγραφή: | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Η επιθυμητή διεύθυνση URL ανακατεύθυνσης θα ενσωματωθεί στο QR | |
qrType | String | qr2 | qrType καθορίζουν τη συμπεριφορά του qr όπως single redirect url ή multi redirect url ("qr2" ή "murl") | |
qrCategory | String | url | qrCategory ορίζουν διαφορετικούς τύπους qr όπως url, Vcard, facebook, κλπ. Ελέγξτε τον παρακάτω πίνακα qrCategory. | |
qr: | JSON Object | Σχεδιάστε τον κωδικό qr σας, όπως το χρώμα, τα μοτίβα δεδομένων, τα μάτια, κ.λπ. μέσα σε αυτό το αντικείμενο | ||
size | Number | 500 | Μέγεθος του qr | |
logo | String (url) | null | Προσθέστε οποιοδήποτε url λογότυπο για να ενεργοποιήσετε το λογότυπο στο κέντρο του QR | |
colorDark | String | #5e0bf0 | Χρώμα των μοτίβων qr | |
backgroundColor | String | #ffffff | Χρώμα φόντου του QR. (Σημείωση: Επιλέγετε πάντα φωτεινό χρώμα για ένα πλήρως ανιχνεύσιμο QR) | |
gradient | Boolean | false | Ορίστε "true" για να ενεργοποιήσετε το χρώμα διαβάθμισης | |
grdType | Number | 0 (Left-to-Right) | Ελέγξτε τον παρακάτω πίνακα για το grdType | |
color01 | String | #5e0bf0 | Χρώμα διαβάθμισης 1 των μοτίβων qr | |
color02 | String | #f30505 | Χρώμα διαβάθμισης 2 των μοτίβων qr | |
eye_color | Boolean | false | Ορίστε "true" για να αλλάξετε το χρώμα των ματιών | |
eye_color01 | String | #5e0bf0 | Χρώμα του εξωτερικού ματιού | |
eye_color02 | String | #f30505 | Χρώμα του εσωτερικού ματιού | |
eye_outer | String | eyeOuter0 | Διαφορετικός σχεδιασμός του εξωτερικού ματιού, ελέγξτε τον παρακάτω πίνακα για όλα τα σχέδια σχεδιασμού | |
eye_inner | String | eyeInner0 | Διαφορετικός σχεδιασμός του εσωτερικού ματιού, ελέγξτε τον παρακάτω πίνακα για όλα τα σχέδια σχεδιασμού | |
qrData | String | pattern0 | Διαφορετικός σχεδιασμός προτύπων δεδομένων qr, ελέγξτε τον παρακάτω πίνακα για όλα τα πρότυπα σχεδιασμού | |
qrFormat | String | png | Λήψη δυαδικού αρχείου εικόνας τύπου "png" ή "svg" | |
transparentBkg | Boolean | false | Εάν είναι ενεργοποιημένο, ο κωδικός QR θα έχει διαφανές φόντο | |
frame | Number | null | Εάν είναι ενεργοποιημένο, το QR θα έχει ένα πλαίσιο. Ελέγξτε τον παρακάτω πίνακα για τα σχέδια πλαισίων | |
frameColor | String | null | Χρώμα πλαισίου αλλάξτε το χρώμα του κειμένου πλαισίου | |
frameText | String | SCAN ME | Το κείμενο του πλαισίου εμφανίζεται πάνω από το πλαίσιο QR |
Παράδειγμα
URL | /api/campaign |
Μέθοδοι | 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)
Παράμετρος | Τύπος | αξία | Περιγραφή: |
---|---|---|---|
Αριστερά - Δεξιά | String | linear | Ροή κλίσης από αριστερά προς τα δεξιά |
Πάνω - Κάτω | String | upDown | Ροή κλίσης Από πάνω προς τα κάτω |
ΒΔ - ΝΑ | String | diagonal1 | Ροή κλίσης Διαγώνια προς τα κάτω |
ΝΔ - ΒΑ | String | diagonal2 | Ροή κλίσης Διαγώνια προς τα πάνω |
Ακτινική | String | radial | Ροή βαθμίδας Ακτινικά |
eye_outer (Default 0)
Παράμετρος | Τύπος | αξία | Περιγραφή: |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Παράμετρος | Τύπος | αξία | Περιγραφή: |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Παράμετρος | Τύπος | αξία | Περιγραφή: |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Παράμετρος | Τύπος | αξία | Περιγραφή: |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Παρακολουθήστε τα δεδομένα QR σας, Αριθμός σαρώσεων, Χώρα, Πόλη, Τύπος συσκευής
URL | /data/qrid?period=month&tz=Asia/Singapore |
Μέθοδοι | GET |
Δικαίωμα πρόσβασης | Bearer API KEY |
Απάντηση | JSON object of track data |
Παράμετρος αίτησης
Παράμετρος | Τύπος | Περιγραφή: |
---|---|---|
qrId | params | Μοναδικό αναγνωριστικό του qr |
period | query | "day" (Δεδομένα της τρέχουσας ημέρας) "week" (Δεδομένα της τρέχουσας εβδομάδας) "month" (Δεδομένα του τρέχοντος μήνα) "months" (Δεδομένα του τρέχοντος έτους) "year" (Ετήσια δεδομένα) |
tz | query | Default Ασία/Σιγκαπούρη |
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. Ανεβάστε το λογότυπό σας
URL | /accounts/uploads/ |
Μέθοδοι | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |