Mã QR

Tạo mã QR với logo, màu, kiểu và loại nội dung, rồi liệt kê hoặc cập nhật.

Các loại được hỗ trợ

Truyền type là một trong các khóa này. Trường nội dung đổi theo loại.

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

Tạo mã QR

Gửi JSON trong thân yêu cầu. name và type là bắt buộc. Với loại url, gửi url. Thêm style, màu và qr_code_logo để khớp mã thiết kế từ studio. Loại file không có trên API.

Tên	Kiểu	Bắt buộc	Mặc định	Mô tả
name	string	Có	—	Nhãn lưu trên tài nguyên.
type	string	Có	url	Loại nội dung. Một trong các khóa QR được hỗ trợ, trừ file.
url	string	Không	—	URL đích. Bắt buộc khi type là url.
text	string	Không	—	Văn bản thuần. Bắt buộc khi type là text. Với văn bản hàng loạt, tách dòng trong trường này.
url_dynamic	boolean	Không	false	Nếu true, một liên kết rút gọn được tạo và QR mã hóa liên kết đó để đích có thể đổi sau.
project_id	integer	Không	—	Dự án để gắn tài nguyên.
is_bulk	boolean	Không	false	Nếu true và type là text, mỗi dòng trong text tạo một QR.
style	string	Không	square	Hình module. Ví dụ: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Không	square	Hình mẫu tìm bên trong. Ví dụ: square, dot, circle, rounded.
outer_eye_style	string	Không	square	Hình mẫu tìm bên ngoài. Ví dụ: square, circle, rounded, flower.
size	integer	Không	500	Kích thước ảnh theo pixel, 50–2000.
margin	integer	Không	0	Module vùng yên, 0–25.
ecc	string	Không	M	Sửa lỗi: L, M, Q hoặc H. Dùng H khi thêm logo.
foreground_type	string	Không	color	color hoặc gradient.
foreground_color	string	Không	#000000	Màu module dạng HEX.
foreground_gradient_style	string	Không	horizontal	vertical, horizontal, diagonal, inverse_diagonal hoặc radial.
foreground_gradient_one	string	Không	—	Màu HEX chuyển màu thứ nhất.
foreground_gradient_two	string	Không	—	Màu HEX chuyển màu thứ hai.
background_color	string	Không	#ffffff	Màu HEX nền. Giữ sáng hơn các module.
background_color_transparency	integer	Không	0	Độ trong suốt nền, 0–100.
custom_eyes_color	boolean	Không	false	Nếu true, mắt dùng eyes_inner_color và eyes_outer_color.
eyes_inner_color	string	Không	#000000	Màu HEX mắt trong.
eyes_outer_color	string	Không	#000000	Màu HEX mắt ngoài.
qr_code_logo	string	Không	—	URL ảnh logo hoặc khóa tệp đã tải lên.
qr_code_logo_size	number	Không	25	Cỡ logo theo phần trăm QR, 5–40.
frame	string	Không	—	Khóa khung tùy chọn từ studio.
frame_text	string	Không	—	Chú thích vẽ trên khung.

Trường nội dung theo loại

Tên	Kiểu	Bắt buộc	Mặc định	Mô tả
phone	string	Không	—	Số điện thoại khi type là phone.
sms	string	Không	—	Số điện thoại khi type là sms.
sms_body	string	Không	—	Nội dung tin SMS.
email	string	Không	—	Người nhận khi type là email.
email_subject	string	Không	—	Tiêu đề email.
email_body	string	Không	—	Nội dung email.
whatsapp	string	Không	—	Số WhatsApp, chỉ chữ số.
whatsapp_body	string	Không	—	Văn bản WhatsApp điền sẵn.
wifi_ssid	string	Không	—	Tên mạng khi type là wifi.
wifi_password	string	Không	—	Mật khẩu Wi-Fi.
wifi_encryption	string	Không	WPA	nopass, WEP, WPA hoặc WPA/WPA2.
location_latitude	number	Không	—	Vĩ độ khi type là location.
location_longitude	number	Không	—	Kinh độ khi type là location.
event	string	Không	—	Tiêu đề sự kiện khi type là event.
event_start_datetime	string	Không	—	Ngày giờ ISO lúc sự kiện bắt đầu.
vcard first_name / last_name / email	string	Không	—	Trường vCard: first_name, last_name, email và các khóa studio khác.

Ví dụ yêu cầu

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}'

Thêm ví dụ

QR chuyển màu

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

QR Wi-Fi

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

Ví dụ phản hồi

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

Liệt kê mã QR

Tên	Kiểu	Bắt buộc	Mô tả
page	integer	Không	Page number (default 1)
results_per_page	integer	Không	Items per page (default 25, max 100)
search	string	Không	Search term
search_by	string	Không	Column to search
order_by	string	Không	Sort column
order_type	string	Không	asc or desc
datetime_start	string	Không	ISO datetime filter start
datetime_end	string	Không	ISO datetime filter end
project_id	integer	Không	—
type	string	Không	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

Đọc một mã QR

Tên	Kiểu	Bắt buộc	Mô tả
id	integer	Có	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

Cập nhật mã QR

Tên	Kiểu	Bắt buộc	Mặc định	Mô tả
id	integer	Có	—	—
name	string	Không	—	Nhãn lưu trên tài nguyên.
type	string	Không	url	Loại nội dung. Một trong các khóa QR được hỗ trợ, trừ file.
url	string	Không	—	URL đích. Bắt buộc khi type là url.
text	string	Không	—	Văn bản thuần. Bắt buộc khi type là text. Với văn bản hàng loạt, tách dòng trong trường này.
url_dynamic	boolean	Không	false	Nếu true, một liên kết rút gọn được tạo và QR mã hóa liên kết đó để đích có thể đổi sau.
project_id	integer	Không	—	Dự án để gắn tài nguyên.
is_bulk	boolean	Không	false	Nếu true và type là text, mỗi dòng trong text tạo một QR.
style	string	Không	square	Hình module. Ví dụ: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Không	square	Hình mẫu tìm bên trong. Ví dụ: square, dot, circle, rounded.
outer_eye_style	string	Không	square	Hình mẫu tìm bên ngoài. Ví dụ: square, circle, rounded, flower.
size	integer	Không	500	Kích thước ảnh theo pixel, 50–2000.
margin	integer	Không	0	Module vùng yên, 0–25.
ecc	string	Không	M	Sửa lỗi: L, M, Q hoặc H. Dùng H khi thêm logo.
foreground_type	string	Không	color	color hoặc gradient.
foreground_color	string	Không	#000000	Màu module dạng HEX.
foreground_gradient_style	string	Không	horizontal	vertical, horizontal, diagonal, inverse_diagonal hoặc radial.
foreground_gradient_one	string	Không	—	Màu HEX chuyển màu thứ nhất.
foreground_gradient_two	string	Không	—	Màu HEX chuyển màu thứ hai.
background_color	string	Không	#ffffff	Màu HEX nền. Giữ sáng hơn các module.
background_color_transparency	integer	Không	0	Độ trong suốt nền, 0–100.
custom_eyes_color	boolean	Không	false	Nếu true, mắt dùng eyes_inner_color và eyes_outer_color.
eyes_inner_color	string	Không	#000000	Màu HEX mắt trong.
eyes_outer_color	string	Không	#000000	Màu HEX mắt ngoài.
qr_code_logo	string	Không	—	URL ảnh logo hoặc khóa tệp đã tải lên.
qr_code_logo_size	number	Không	25	Cỡ logo theo phần trăm QR, 5–40.
frame	string	Không	—	Khóa khung tùy chọn từ studio.
frame_text	string	Không	—	Chú thích vẽ trên khung.

Ví dụ yêu cầu

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

Xóa mã QR

Tên	Kiểu	Bắt buộc	Mô tả
id	integer	Có	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Tên tham số và ví dụ JSON hiển thị bằng tiếng Anh. Thay YOUR_API_KEY bằng khóa của bạn.