API Schema 定义
主接口 /api/v3/label 接收一个 LabelRequest 对象数组 (JSON Array)。
根对象: LabelRequest
| 字段 | 类型 | 说明 |
|---|
tracking_number | String | 可选的请求追踪编号。 |
items | Array<Item> | 必填。需要绘制在 PDF 上的内容元素列表。 |
pdf_params | PdfParams | PDF 文档本身的配置 (尺寸, 元数据, profile)。 |
PdfParams (文档设置)
控制生成 PDF 的物理属性和元数据。
| 字段 | 类型 | 说明 |
|---|
width | float | 页面宽度 (毫米 mm)。 |
height | float | 页面高度 (毫米 mm)。 |
pdf_profile | String | 合规级别 (如 "pdfa-1b", "" 表示标准)。详见 Profiles。 |
metadata_title | String | 文档标题。PDF/A-UA1 必填 (缺失将触发 E003)。 |
metadata_authors | String | 作者。 |
metadata_subject | String | 主题/关键词。 |
metadata_producer | String | 生产者名称。 |
metadata_language | String | ISO 639-1 代码 (如 "zh"). 缺失时自动检测。 |
Item (内容容器)
各类图形元素的容器。所有字段均为可选数组。
| 字段 | 类型 | 说明 |
|---|
1d_params | Array<OneDParams> | 一维条码 (Linear barcodes)。 |
2d_params | Array<TwoDParams> | 二维码 (Matrix barcodes)。 |
text_elements | Array<TextElement> | 绝对定位文本。 |
lines | Array<Line> | 矢量线条。 |
images | Array<ImageElement> | 栅格图片 (JPG/PNG)。 |
rectangles | Array<Rectangle> | 矢量矩形。 |
OneDParams (一维条码)
| 字段 | 类型 | 说明 |
|---|
one_d_content | String | 编码数据。 |
format | String | 码制: Code128, Code39, EAN13 等。 |
size | BarcodeSize | 包含 width, height, module_width。 |
position | Position | 包含 x, y 坐标。 |
color | String | 条码颜色 (Hex, 例如 #000000)。 |
human_readable_text | HumanReadableText | 条码附属文本。 |
background_color | String | 背景填充色。 |
quiet_zone | int | 静区大小 (单位: 模组)。 |
TwoDParams (二维码)
| 字段 | 类型 | 说明 |
|---|
two_d_content | String | 编码数据。 |
format | String | 码制: QRCode, DataMatrix, PDF417。 |
module_size | float | 单个模组大小 (像素) mm。 |
x | float | X 坐标。 |
y | float | Y 坐标。 |
TextElement (绝对定位文本)
| 字段 | 类型 | 说明 |
|---|
content | String | 显示文本。 |
x | float | X 坐标。 |
y | float | Y 坐标。 |
font_size | float | 字号 (pt)。 |
font_name | String | 字体名称 (需预加载)。 |
bold | bool | 粗体开关。 |
align | String | 对齐: Left, Center, Right。 |
color | String | 文本颜色 (Hex)。 |