Mã vạch

Tạo mã vạch trên 34 symbology, với tùy chọn màu, kích thước và nhãn.

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

Truyền type là một trong các khóa symbology này. value phải khớp quy tắc của loại đó.

C32
C39
C39+
C39E
C39E+
C93
S25
S25+
I25
I25+
ITF14
C128
C128A
C128B
C128C
EAN2
EAN5
EAN8
EAN13
UPCA
UPCE
MSI
MSI+
POSTNET
PLANET
TELEPENALPHA
TELEPENNUMERIC
RMS4CC
KIX
IMB
CODABAR
CODE11
PHARMA
PHARMA2T

POST/api/v1/barcodes

Tạo mã vạch

Gửi JSON gồm name, type và value. type là khóa symbology như C128 hoặc EAN13. Màu, width_scale, height và display_text điều khiển ảnh được render.

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ó	C128	Khóa symbology như C128, EAN13 hoặc UPCA.
value	string	Có	—	Dữ liệu mã hóa trong mã vạch. Phải hợp lệ với loại đã chọn.
project_id	integer	Không	—	Dự án để gắn tài nguyên.
is_bulk	boolean	Không	false	Nếu true, mỗi dòng trong value tạo một mã vạch.
foreground_color	string	Không	#000000	Màu module dạng HEX.
background_color	string	Không	#ffffff	Màu HEX nền. Giữ sáng hơn các module.
width_scale	integer	Không	2	Hệ số bề rộng vạch, 1–10.
height	integer	Không	30	Chiều cao vạch theo pixel, 30–1000.
display_text	boolean	Không	false	Nếu true, value được in dưới các vạch.

Ví dụ yêu cầu

curl -X POST 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Product SKU",
  "type": "C128",
  "value": "FORQR-1001",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "width_scale": 2,
  "height": 80,
  "display_text": true
}'

Thêm ví dụ

EAN-13

curl -X POST 'https://forqrcode.com/api/v1/barcodes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Retail EAN-13",
  "type": "EAN13",
  "value": "5901234123457",
  "height": 70,
  "display_text": true
}'

Ví dụ phản hồi

{
  "data": {
    "id": 1,
    "type": "C128",
    "name": "Product SKU",
    "value": "FORQR-1001",
    "barcode": "https://…/barcodes/…/barcode.svg"
  }
}

GET/api/v1/barcodes

Liệt kê mã vạch

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

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

GET/api/v1/barcodes/{id}

Đọc một mã vạch

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

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

PATCH/api/v1/barcodes/{id}

Cập nhật mã vạch

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	C128	Khóa symbology như C128, EAN13 hoặc UPCA.
value	string	Không	—	Dữ liệu mã hóa trong mã vạch. Phải hợp lệ với loại đã chọn.
project_id	integer	Không	—	Dự án để gắn tài nguyên.
is_bulk	boolean	Không	false	Nếu true, mỗi dòng trong value tạo một mã vạch.
foreground_color	string	Không	#000000	Màu module dạng HEX.
background_color	string	Không	#ffffff	Màu HEX nền. Giữ sáng hơn các module.
width_scale	integer	Không	2	Hệ số bề rộng vạch, 1–10.
height	integer	Không	30	Chiều cao vạch theo pixel, 30–1000.
display_text	boolean	Không	false	Nếu true, value được in dưới các vạch.

Ví dụ yêu cầu

curl -X PATCH 'https://forqrcode.com/api/v1/barcodes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": "FORQR-2002",
  "height": 90
}'

DELETE/api/v1/barcodes/{id}

Xóa mã vạch

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

curl -X DELETE 'https://forqrcode.com/api/v1/barcodes/{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.