Skip to content

API Schema 定义

主接口 /api/v3/label 接收一个 LabelRequest 对象数组 (JSON Array)。

根对象: LabelRequest

字段类型说明
tracking_numberString可选的请求追踪编号。
itemsArray<Item>必填。需要绘制在 PDF 上的内容元素列表。
pdf_paramsPdfParamsPDF 文档本身的配置 (尺寸, 元数据, profile)。

PdfParams (文档设置)

控制生成 PDF 的物理属性和元数据。

字段类型说明
widthfloat页面宽度 (毫米 mm)。
heightfloat页面高度 (毫米 mm)。
pdf_profileString合规级别 (如 "pdfa-1b", "" 表示标准)。详见 Profiles
metadata_titleString文档标题。PDF/A-UA1 必填 (缺失将触发 E003)。
metadata_authorsString作者。
metadata_subjectString主题/关键词。
metadata_producerString生产者名称。
metadata_languageStringISO 639-1 代码 (如 "zh"). 缺失时自动检测。

Item (内容容器)

各类图形元素的容器。所有字段均为可选数组。

字段类型说明
1d_paramsArray<OneDParams>一维条码 (Linear barcodes)。
2d_paramsArray<TwoDParams>二维码 (Matrix barcodes)。
text_elementsArray<TextElement>绝对定位文本。
linesArray<Line>矢量线条。
imagesArray<ImageElement>栅格图片 (JPG/PNG)。
rectanglesArray<Rectangle>矢量矩形。

OneDParams (一维条码)

字段类型说明
one_d_contentString编码数据。
formatString码制: Code128, Code39, EAN13 等。
sizeBarcodeSize包含 width, height, module_width
positionPosition包含 x, y 坐标。
colorString条码颜色 (Hex, 例如 #000000)。
human_readable_textHumanReadableText条码附属文本。
background_colorString背景填充色。
quiet_zoneint静区大小 (单位: 模组)。

TwoDParams (二维码)

字段类型说明
two_d_contentString编码数据。
formatString码制: QRCode, DataMatrix, PDF417
module_sizefloat单个模组大小 (像素) mm。
xfloatX 坐标。
yfloatY 坐标。

TextElement (绝对定位文本)

字段类型说明
contentString显示文本。
xfloatX 坐标。
yfloatY 坐标。
font_sizefloat字号 (pt)。
font_nameString字体名称 (需预加载)。
boldbool粗体开关。
alignString对齐: Left, Center, Right
colorString文本颜色 (Hex)。