条形码

按 34 种 symbology 创建条形码，可设置颜色、尺寸和标签。

支持的类型

将 type 设为下列 symbology 键之一。value 必须符合该类型的规则。

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

创建条形码

发送包含 name、type 和 value 的 JSON。type 是 symbology 键，例如 C128 或 EAN13。颜色、width_scale、height 和 display_text 控制渲染图像。

名称	类型	必填	默认	描述
name	string	是	—	保存在资源上的标签。
type	string	是	C128	symbology 键，例如 C128、EAN13 或 UPCA。
value	string	是	—	条形码中编码的数据。必须对所选类型有效。
project_id	integer	否	—	要将资源附加到的项目。
is_bulk	boolean	否	false	若为 true，则 value 中每行创建一个条形码。
foreground_color	string	否	#000000	模块颜色，HEX。
background_color	string	否	#ffffff	背景 HEX 颜色。请保持比模块更浅。
width_scale	integer	否	2	条宽乘数，1–10。
height	integer	否	30	条高（像素），30–1000。
display_text	boolean	否	false	若为 true，则在条下方打印 value。

请求示例

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
}'

更多示例

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
}'

响应示例

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

GET/api/v1/barcodes

列出条形码

名称	类型	必填	描述
page	integer	否	Page number (default 1)
results_per_page	integer	否	Items per page (default 25, max 100)
search	string	否	Search term
search_by	string	否	Column to search
order_by	string	否	Sort column
order_type	string	否	asc or desc
datetime_start	string	否	ISO datetime filter start
datetime_end	string	否	ISO datetime filter end

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

GET/api/v1/barcodes/{id}

读取一个条形码

名称	类型	必填	描述
id	integer	是	—

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

PATCH/api/v1/barcodes/{id}

更新条形码

名称	类型	必填	默认	描述
id	integer	是	—	—
name	string	否	—	保存在资源上的标签。
type	string	否	C128	symbology 键，例如 C128、EAN13 或 UPCA。
value	string	否	—	条形码中编码的数据。必须对所选类型有效。
project_id	integer	否	—	要将资源附加到的项目。
is_bulk	boolean	否	false	若为 true，则 value 中每行创建一个条形码。
foreground_color	string	否	#000000	模块颜色，HEX。
background_color	string	否	#ffffff	背景 HEX 颜色。请保持比模块更浅。
width_scale	integer	否	2	条宽乘数，1–10。
height	integer	否	30	条高（像素），30–1000。
display_text	boolean	否	false	若为 true，则在条下方打印 value。

请求示例

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}

删除条形码

名称	类型	必填	描述
id	integer	是	—

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

参数名与 JSON 示例为英文。请将 YOUR_API_KEY 替换为您的密钥。