Tài liệu về API QRTIGER
API mã QR tùy chỉnh của chúng tôi cung cấp một giải pháp chuyên nghiệp cho các thương hiệu cần có mẫu mã QR tùy chỉnh với hệ thống theo dõi dữ liệu, mã QR động hoặc mã QR với số lượng lớn và có mã QR được tích hợp trong CRM của họ.
API của chúng tôi và có sẵn trên 'Mashape' cho bất kỳ câu hỏi nào khác, bạn luôn có thể 'liên hệ với chúng tôi' API của chúng tôi có thể được sử dụng trên toàn thế giới, nếu bạn cần mã QR có sẵn ở Trung Quốc, vui lòng liên hệ với chúng tôi. Chúng tôi cũng có thể thực hiện mã QR tùy chỉnh cho thanh toán di động.
qrId:
Tài liệu
Kiểm tra video YouTube này cách sử dụng nó
Tạo mã QR
1.Đăng nhập trước và nhận Khóa API để ủy quyền cho Theo dõi dữ liệu --> Cài đặt tài khoản --> Khóa API
Đăng nhập trước và nhận Khóa API để ủy quyền cho Theo dõi dữ liệu --> Cài đặt tài khoản --> Khóa API
2.Add this API key in every req (GET/POST) as Authorization: Bearer Khóa API
Add this API key in every req (GET/POST) as Authorization: Bearer Khóa API
3. Tạo mã QR tĩnh tùy chỉnh
Đường liên kết | /api/qr/static |
Phương thức | POST |
Phân quyền | Bearer API KEY |
phản hồi | Binary Image File (PNG, SVG) |
Yêu cầu tham số
qrCategory | string | url | qrCategory xác định loại qr khác nhau như url, Vcard, facebook, v.v. Kiểm tra bảng qrCategory bên dưới. |
text | String | https://qrcode-tiger.com | Url chuyển hướng mong muốn của bạn sẽ được nhúng vào QR |
size | number | 500 | Kích thước của qr |
logo | url | null | Thêm bất kỳ url logo nào để thêm logo ở giữa QR |
colorDark | string | #5e0bf0 | Màu sắc của các mẫu qr |
backgroundColor | String | #ffffff | Màu nền của QR. (Lưu ý: Luôn chọn màu sáng cho QR có thể quét đầy đủ) |
gradient | Boolean | false | Đặt "true" để bật màu gradient |
grdType | Number | 0 (Left-to-Right) | Kiểm tra bảng bên dưới để biết grdType |
color01 | String | #5e0bf0 | Màu gradient 1 của các mẫu qr |
color02 | String | #f30505 | Màu gradient 2 của các mẫu qr |
eye_color | Boolean | false | Đặt “true” để thay đổi màu mắt |
eye_color01 | String | #5e0bf0 | Màu của mắt ngoài |
eye_color02 | String | #f30505 | Màu của mắt trong |
eye_outer | String | eyeOuter0 | Thiết kế khác của mắt ngoài, hãy kiểm tra bảng bên dưới để biết tất cả các mẫu thiết kế |
eye_inner | String | eyeInner0 | Thiết kế khác của mắt trong, hãy kiểm tra bảng bên dưới để biết tất cả các mẫu thiết kế |
qrData | String | pattern0 | Thiết kế khác của các mẫu dữ liệu QR, kiểm tra bên dưới bảng cho tất cả các mẫu thiết kế |
qrFormat | String | png | Tải xuống loại tệp hình ảnh nhị phân “png” hoặc “svg” |
transparentBkg | Boolean | false | Nếu được kích hoạt, mã QR sẽ có nền trong suốt |
frame | Number | null | Nếu được kích hoạt, QR sẽ có một khung. Kiểm tra bên dưới bảng để biết thiết kế khung |
frameColor | String | null | Màu khung thay đổi màu của văn bản |
frameText | String | SCAN ME | Khung văn bản được hiển thị trên khung QR |
Ví dụ
Đường liên kết | /api/qr/static |
Phương thức | POST |
Thông số | { "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" } |
phản hồi | { "data": "base 64 QR image data", "url": "1601477992984.png" } |
4. Nhận danh sách tất cả các chiến dịch QR thuộc các danh mục QR khác nhau
Đường liên kết | /api/campaign/ |
Phương thức | GET |
Phân quyền | Bearer API KEY |
phản hồi | JSON object of QR list |
GET /campaign/?page=1&limit=5&sort=1
Tham số truy vấn
Thông số | Mặc định | Mô tả |
---|---|---|
page | 1 | số lượng trang |
limit | 5 | số chiến dịch trên mỗi trang |
sort | 1 | Sắp xếp theo Ngày (1) hoặc Tên (2) |
category | url | danh mục xác định loại QR khác nhau như url, Vcard, facebook, v.v. Kiểm tra bảng qrCategory bên dưới. |
Ví dụ
Đường liên kết | /api/campaign/?page=1&limit=5&sort=1&category=url |
Phương thức | GET |
Thông số | { "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" } |
phản hồi | { "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. Tạo mã QR trực quan tùy chỉnh động
Đường liên kết | /api/campaign/ |
Phương thức | POST |
Phân quyền | Bearer API KEY |
phản hồi | Binary Image File (PNG, SVG) |
Tham số truy vấn
Thông số | Loại | Mặc định | Mô tả | |
---|---|---|---|---|
qrUrl | String | https://qrcode-tiger.com | Url chuyển hướng mong muốn của bạn sẽ được nhúng vào QR | |
qrType | String | qr2 | qrType xác định hành vi của qr như url chuyển hướng đơn hoặc url đa chuyển hướng ("qr2" hoặc "murl") | |
qrCategory | String | url | qrCategory xác định loại qr khác nhau như url, Vcard, facebook, v.v. Kiểm tra bảng qrCategory bên dưới. | |
qr: | JSON Object | Thiết kế mã qr của bạn như màu sắc, mẫu dữ liệu, mắt, v.v. trong đối tượng này | ||
size | Number | 500 | Kích thước của qr | |
logo | String (url) | null | Thêm bất kỳ url logo nào để thêm logo ở giữa QR | |
colorDark | String | #5e0bf0 | Màu sắc của các mẫu qr | |
backgroundColor | String | #ffffff | Màu nền của QR. (Lưu ý: Luôn chọn màu sáng cho QR có thể quét đầy đủ) | |
gradient | Boolean | false | Đặt "true" để bật màu gradient | |
grdType | Number | 0 (Left-to-Right) | Kiểm tra bảng bên dưới để biết grdType | |
color01 | String | #5e0bf0 | Màu gradient 1 của các mẫu qr | |
color02 | String | #f30505 | Màu gradient 2 của các mẫu qr | |
eye_color | Boolean | false | Đặt “true” để thay đổi màu mắt | |
eye_color01 | String | #5e0bf0 | Màu của mắt ngoài | |
eye_color02 | String | #f30505 | Màu của mắt trong | |
eye_outer | String | eyeOuter0 | Thiết kế khác của mắt ngoài, hãy kiểm tra bảng bên dưới để biết tất cả các mẫu thiết kế | |
eye_inner | String | eyeInner0 | Thiết kế khác của mắt trong, hãy kiểm tra bảng bên dưới để biết tất cả các mẫu thiết kế | |
qrData | String | pattern0 | Thiết kế khác của các mẫu dữ liệu QR, kiểm tra bên dưới bảng cho tất cả các mẫu thiết kế | |
qrFormat | String | png | Tải xuống loại tệp hình ảnh nhị phân “png” hoặc “svg” | |
transparentBkg | Boolean | false | Nếu được kích hoạt, mã QR sẽ có nền trong suốt | |
frame | Number | null | Nếu được kích hoạt, QR sẽ có một khung. Kiểm tra bên dưới bảng để biết thiết kế khung | |
frameColor | String | null | Màu khung thay đổi màu của văn bản | |
frameText | String | SCAN ME | Khung văn bản được hiển thị trên khung QR |
Ví dụ
Đường liên kết | /api/campaign |
Phương thức | 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)
Thông số | Loại | Giá trị | Mô tả |
---|---|---|---|
Trái - phải | String | linear | Màu Gradient từ trái sang phải |
Trên cùng - Dưới cùng | String | upDown | Luồng gradient Từ trên xuống dưới |
NW - SE | String | diagonal1 | Dòng chảy Gradient theo đường chéo xuống |
SW - NE | String | diagonal2 | Dòng chảy Gradient theo đường chéo lên trên |
Xuyên tâm | String | radial | Luồng gradient Radially |
eye_outer (Default 0)
Thông số | Loại | Giá trị | Mô tả |
---|---|---|---|
eye_outer | String | eyeOuter0 | |
eyeOuter1 | |||
eyeOuter2 | |||
eyeOuter3 | |||
eyeOuter4 | |||
eyeOuter5 | |||
eyeOuter6 | |||
eyeOuter7 | |||
eyeOuter8 | |||
eyeOuter9 |
eye_inner
Thông số | Loại | Giá trị | Mô tả |
---|---|---|---|
eye_inner | String | eyeInner0 | |
eyeInner1 | |||
eyeInner2 | |||
eyeInner3 | |||
eyeInner4 | |||
eyeInner5 | |||
eyeInner6 | |||
eyeInner7 | |||
eyeInner8 | |||
eyeInner9 |
QrData
Thông số | Loại | Giá trị | Mô tả |
---|---|---|---|
qrData | String | pattern0 | |
pattern1 | |||
pattern2 | |||
pattern3 | |||
pattern4 | |||
pattern5 | |||
pattern6 | |||
pattern7 | |||
pattern8 | |||
pattern9 | |||
pattern10 | |||
pattern11 |
Frame (Default : null)
Thông số | Loại | Giá trị | Mô tả |
---|---|---|---|
frame | Number | 1 | |
2 | |||
3 |
5. Theo dõi Dữ liệu QR của bạn, Số lần quét, Quốc gia, Thành phố, Loại thiết bị
Đường liên kết | /data/qrid?period=month&tz=Asia/Singapore |
Phương thức | GET |
Phân quyền | Bearer API KEY |
phản hồi | JSON object of track data |
Yêu cầu tham số
Thông số | Loại | Mô tả |
---|---|---|
qrId | params | Id duy nhất của qr |
period | query | "ngày" (Dữ liệu của ngày hiện tại) "tuần" (Dữ liệu của tuần hiện tại) "tháng" (Dữ liệu của tháng hiện tại) "tháng" (Dữ liệu của năm hiện tại) “Năm” (Dữ liệu hàng năm) |
tz | query | Mặc định Châu Á/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. Tải lên logo của bạn
Đường liên kết | /accounts/uploads/ |
Phương thức | POST |
Content-Type | multipart/form-data |
Form-Field | File |
Response | Image file url {“qrUrl”: 1526460566643.png} |