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:
example 1
example 2
example 3
example 4
example 5

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

2.

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ứcPOST
Phân quyềnBearer API KEY
phản hồiBinary Image File (PNG, SVG)
Yêu cầu tham số
qrCategorystringurlqrCategory 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.
textStringhttps://qrcode-tiger.comUrl chuyển hướng mong muốn của bạn sẽ được nhúng vào QR
sizenumber500Kích thước của qr
logourlnullThêm bất kỳ url logo nào để thêm logo ở giữa QR
colorDarkstring#5e0bf0Màu sắc của các mẫu qr
backgroundColorString#ffffffMàu nền của QR. (Lưu ý: Luôn chọn màu sáng cho QR có thể quét đầy đủ)
gradientBooleanfalseĐặt "true" để bật màu gradient
grdTypeNumber0 (Left-to-Right)Kiểm tra bảng bên dưới để biết grdType
color01String#5e0bf0Màu gradient 1 của các mẫu qr
color02String#f30505Màu gradient 2 của các mẫu qr
eye_colorBooleanfalseĐặt “true” để thay đổi màu mắt
eye_color01String#5e0bf0Màu của mắt ngoài
eye_color02String#f30505Màu của mắt trong
eye_outerStringeyeOuter0Thiế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_innerStringeyeInner0Thiế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ế
qrDataStringpattern0Thiế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ế
qrFormatStringpngTải xuống loại tệp hình ảnh nhị phân “png” hoặc “svg”
transparentBkgBooleanfalseNếu được kích hoạt, mã QR sẽ có nền trong suốt
frameNumbernullNế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
frameColorStringnullMàu khung thay đổi màu của văn bản
frameTextStringSCAN MEKhung 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ứcPOST
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
example 5
{
  "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ứcGET
Phân quyềnBearer API KEY
phản hồiJSON object of QR list
GET /campaign/?page=1&limit=5&sort=1
Tham số truy vấn
Thông sốMặc địnhMô tả
page1số lượng trang
limit5số chiến dịch trên mỗi trang
sort1Sắp xếp theo Ngày (1) hoặc Tên (2)
categoryurldanh 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ứcGET
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ứcPOST
Phân quyềnBearer API KEY
phản hồiBinary Image File (PNG, SVG)
Tham số truy vấn
Thông sốLoạiMặc địnhMô tả
qrUrlStringhttps://qrcode-tiger.comUrl chuyển hướng mong muốn của bạn sẽ được nhúng vào QR
qrTypeStringqr2qrType 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")
qrCategoryStringurlqrCategory 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 ObjectThiế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
sizeNumber500Kích thước của qr
logoString (url)nullThêm bất kỳ url logo nào để thêm logo ở giữa QR
colorDarkString#5e0bf0Màu sắc của các mẫu qr
backgroundColorString#ffffffMàu nền của QR. (Lưu ý: Luôn chọn màu sáng cho QR có thể quét đầy đủ)
gradientBooleanfalseĐặt "true" để bật màu gradient
grdTypeNumber0 (Left-to-Right)Kiểm tra bảng bên dưới để biết grdType
color01String#5e0bf0Màu gradient 1 của các mẫu qr
color02String#f30505Màu gradient 2 của các mẫu qr
eye_colorBooleanfalseĐặt “true” để thay đổi màu mắt
eye_color01String#5e0bf0Màu của mắt ngoài
eye_color02String#f30505Màu của mắt trong
eye_outerStringeyeOuter0Thiế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_innerStringeyeInner0Thiế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ế
qrDataStringpattern0Thiế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ế
qrFormatStringpngTải xuống loại tệp hình ảnh nhị phân “png” hoặc “svg”
transparentBkgBooleanfalseNếu được kích hoạt, mã QR sẽ có nền trong suốt
frameNumbernullNế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
frameColorStringnullMàu khung thay đổi màu của văn bản
frameTextStringSCAN MEKhung văn bản được hiển thị trên khung QR
Ví dụ
Đường liên kết/api/campaign
Phương thứcPOST
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
example 5
grdType (Default 0)
Thông sốLoạiGiá trịMô tả
Trái - phảiStringlinearMàu Gradient từ trái sang phải
Trên cùng - Dưới cùngStringupDownLuồng gradient Từ trên xuống dưới
NW - SEStringdiagonal1Dòng chảy Gradient theo đường chéo xuống
SW - NEStringdiagonal2Dòng chảy Gradient theo đường chéo lên trên
Xuyên tâmStringradialLuồng gradient Radially
eye_outer (Default 0)
Thông sốLoạiGiá trịMô tả
eye_outerStringeyeOuter0
eyeOuter1
eyeOuter2
eyeOuter3
eyeOuter4
eyeOuter5
eyeOuter6
eyeOuter7
eyeOuter8
eyeOuter9
eye_inner
Thông sốLoạiGiá trịMô tả
eye_innerStringeyeInner0
eyeInner1
eyeInner2
eyeInner3
eyeInner4
eyeInner5
eyeInner6
eyeInner7
eyeInner8
eyeInner9
QrData
Thông sốLoạiGiá trịMô tả
qrDataStringpattern0
pattern1
pattern2
pattern3
pattern4
pattern5
pattern6
pattern7
pattern8
pattern9
pattern10
pattern11
Frame (Default : null)
Thông sốLoạiGiá trịMô tả
frameNumber1
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ứcGET
Phân quyềnBearer API KEY
phản hồiJSON object of track data
Yêu cầu tham số
Thông sốLoạiMô tả
qrIdparamsId duy nhất của qr
periodquery
"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)
tzqueryMặ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ứcPOST
Content-Typemultipart/form-data
Form-FieldFile
ResponseImage file url {“qrUrl”: 1526460566643.png}