Hướng dẫn API QR Code cho Nhà phát triển

Khóa API

Khóa API cho tài khoản của bạn có thể được tạo trên trang tài khoản. Khóa API có thể được bao gồm trong yêu cầu dưới dạng tham số URL, ví dụ: https://genqrcode.com/api/public/generate?apikey=YOUR_API_KEY, hoặc trong tiêu đề `GenQRCode-apikey`. Trong phần còn lại của hướng dẫn này, chúng tôi sẽ giả định sử dụng tiêu đề, vì đây là phương thức an toàn hơn, nhưng cả hai cách đều có thể được sử dụng thay thế cho nhau. Khóa API cần được giữ bí mật và không nên chia sẻ với bất kỳ ai.

Giới hạn tốc độ

Giới hạn tốc độ được áp dụng để đảm bảo việc sử dụng công bằng API. Gói Miễn phí bao gồm 180 token mỗi giờ. Mỗi mã QR thông thường tiêu tốn 1 token, với giới hạn tối đa là 180 token mỗi giờ, tương đương với 1 mã QR mỗi 20 giây. Ngoài ra, các điểm cuối tốc độ cao sẽ tiêu tốn 1/50 token, tương đương với 2,5 mã QR mỗi giây. Các điểm cuối tốc độ cao được khuyến nghị khi không cần tùy chỉnh mã QR. Nếu vượt quá giới hạn token, API sẽ trả về mã trạng thái 429, cho biết yêu cầu đã bị giới hạn.

Việc sử dụng nhiều tài khoản để vượt qua giới hạn này bị nghiêm cấm. Nếu bạn cần giới hạn cao hơn, vui lòng liên hệ với chúng tôi để biết giá.

Thư viện

Java Library

API Mã QR Tĩnh

Ví dụ Mã QR Văn bản

URL	https://api.genqrcode.com/public/generate
Phương thức yêu cầu	POST
Tiêu đề	GenQRCode-apikey: API_KEY
Nội dung yêu cầu	{ "type": 0, "text": "https://genqrcode.com" }
Phản hồi

Ví dụ Mã QR Wi-Fi

URL	https://api.genqrcode.com/public/generate
Phương thức yêu cầu	POST
Tiêu đề	GenQRCode-apikey: API_KEY
Nội dung yêu cầu	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Phản hồi

Ví dụ Mã QR Màu sắc

URL	https://api.genqrcode.com/public/generate
Phương thức yêu cầu	POST
Tiêu đề	GenQRCode-apikey: API_KEY
Nội dung yêu cầu	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Phản hồi

Ví dụ Mã QR với mẫu màu

URL	https://api.genqrcode.com/public/generate
Phương thức yêu cầu	POST
Tiêu đề	GenQRCode-apikey: API_KEY
Nội dung yêu cầu	{ "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" }
Phản hồi

Tham số Khung, Hình dạng và Logo

Dưới đây là tất cả các tham số về khung, hình dạng và logo có thể tùy chỉnh cùng hướng dẫn sử dụng.

Tham số	Loại	Giá trị mặc định	Mô tả
style	Int	0	Kiểu của các ô trong Mã QR. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
inner_eye_style	Int	0	Kiểu của mắt trong Mã QR. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Kiểu của mắt ngoài Mã QR. 0 1 2 3 4 5 6
frame_style	Int	0	Kiểu của khung xung quanh Mã QR. 0 1 2 3 4 5 6 7 8 9 10 11 12 13
frame_text	String	SCAN ME	Văn bản bên trong khung. Cần cấu hình khung có văn bản trước khi văn bản này hiển thị.
logo	String		Logo sử dụng bên trong Mã QR. youtube wifi google-maps facebook spotify threads zoom instagram linkedin genqrcode google-drive airbnb skype snapchat twitter x-twitter reddit
logo_remove_background	Boolean	false	Có loại bỏ nền phía sau logo hay không.

Ví dụ Mã QR với Logo và Hình dạng

URL	https://api.genqrcode.com/public/generate
Phương thức yêu cầu	POST
Tiêu đề	GenQRCode-apikey: API_KEY
Nội dung yêu cầu	{ "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true }
Phản hồi

API Mã QR Tốc độ cao

API Mã QR Tốc độ cao chỉ tiêu tốn 1/50 token so với API thông thường. Mã QR được tối ưu hóa về tốc độ và kích thước tải xuống. Mặc dù hỗ trợ tất cả các loại mã QR, nhưng chỉ hỗ trợ một số tham số tùy chỉnh nhất định.

Ví dụ Mã QR Văn bản tốc độ cao

URL	https://api.genqrcode.com/public/fastgenerate
Phương thức yêu cầu	POST
Tiêu đề	GenQRCode-apikey: API_KEY
Nội dung yêu cầu	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Phản hồi

API Mã QR Tốc độ cao hàng loạt

{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}