创建条形码 - QR Code 生成器 API
PDF4me 创建条形码 使您能够创建独立的条形码和 QR code 支持 150 多种条形码类型的图像,包括 QR codes, Code128, DataMatrix, Aztec, Hanxin, PDF417以及专用格式。这 API 该服务可生成符合规范的条形码图像,并针对打印、移动扫描和数字应用进行了优化。 API 通过接收文本数据和条形码参数 REST API 利用电话 Base64 用于安全传输的编码。此解决方案非常适合库存管理系统、产品标签自动化和企业条形码生成工作流程。
验证您的身份 API 要求
要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份。 REST API。
主要特点
- 综合条形码库支持 150 多种条形码类型,包括 QR codes, Code128, DataMatrix, Aztec, Hanxin, PDF417使用条形码类型参数的邮政编码和专业行业符号
- 独立图像生成:通过文件名指定,无需现有文档或模板即可独立创建高质量条形码图像。
- 高级文本管理使用文本参数配置条形码文本的显示、定位和可见性,并提供专业的格式选项,以实现清晰的呈现效果。
- 企业集成: 简单的 API 采用最少的参数设计,通过适当的参数映射,可无缝集成到现有业务系统和工作流程中。
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有条形码生成操作均通过单个端点执行:
- 方法: POST
- 终点:
/api/v2/CreateBarcode
支持的条形码类型
支持 150 多种条形码类型,可基于以下方式生成全面的条形码: JSON 规格。
常用的一维条形码
- Code128 - 使用条形码类型参数的通用条形码(最多 255 个字符)
- Code39 - 通过文本参数输入字母数字条形码(最多 43 个字符)。
- EAN13/EAN8 - 零售产品代码(13/8 个字符),并注明文件名
- UPC-A/UPC-E - 北美零售(12/8 个字符)使用 API 一体化
常用二维条码
- QR Code - 使用条形码类型参数进行移动扫描(最多 4,296 个字符)
- DataMatrix - 通过文本参数实现高密度 2D 图形(最大 2335 个字符)
- PDF417 - 支持大容量数据(最大 2,710 个字符),并可指定文件名
- Aztec - 出色的纠错功能(最大 3,832 个字符) API 一体化
专业格式
- 邮政编码: USPS, Royal Mail, Australia Post, Deutsche Post 使用条形码类型参数
- 卫生保健: HIBC, GS1 DataBar, Pharmacode 通过文本参数
- 后勤: MaxiCode, SSCC-18, ITF-14, GS1-128 使用文件名规范
- 二维码变体: Micro QR, iQR, rMQR 使用 API 一体化
REST API 参数
创建条形码的完整参数列表 REST API参数按类别组织,以便更好地理解和实施。
重要的: 标有星号 (*) 的参数为必填项,必须提供。 API 正常运作。
必需参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 文本* | String | 要编码到条形码中的文本。文本长度取决于条形码类型。 | PDF4me Create Barcode Sample |
| barcodeType* | String | 条形码格式类型。选项: qrCode, code128, dataMatrix, aztec, hanXin, pdf417, code39, ean13, ean8, upcA, upcE | qrCode |
| hideText* | Boolean | 隐藏条形码文本标签(true=隐藏,false=显示条形码旁边的文本) | false |
| async* | Boolean | 启用异步处理。 true, 这 API 返回 202 状态并提供轮询 URL 在 Location 标题 | true |
输出
这 PDF4me 创建条形码 REST API 根据处理模式的不同,会返回不同的响应。 API 返回条形码 二进制图像文件(PNG 格式)而不是作为 JSON。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同步处理(默认)
什么时候 async 未设置或已设置为 false, 这 API 立即处理请求:
状态码: 200 OK
Content-Type: image/png (或合适的图像格式)
回复正文: 响应体包含条形码图像的二进制数据(PNG (默认格式)。
使用方法:
- 将响应体读取为二进制数据
- 将二进制数据保存为图像文件(例如,.png、.jpg)
- 根据需要使用图像文件
例子 (JavaScript):
const response = await fetch(url, options);
const blob = await response.blob();
const url = URL.createObjectURL(blob);
// Use the URL to display or download the image
例子 (Python):
response = requests.post(url, json=payload, headers=headers)
if response.status_code == 200:
with open('barcode.png', 'wb') as f:
f.write(response.content)
异步处理
什么时候 async: true 已设定, API 异步处理请求:
状态码: 202 Accepted
响应头:
Location: https://api.pdf4me.com/api/v2/CreateBarcode/poll/12345-abcde-67890
投票过程:
- 提取
Location来自 202 响应的标头 - 民意调查 URL 使用 GET 请求
- 继续轮询,直到收到 200 OK 地位
- 最终响应包含条形码图像的二进制数据(PNG 格式)
轮询示例:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const blob = await pollResponse.blob();
// Process blob (barcode image)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
错误响应
这 API 退货标准 HTTP 错误代码及错误详情:
- 无效的请求参数
- 缺少必填字段
文本,条形码类型,隐藏文本,异步) - 无效的条形码类型
- 文本长度超过条形码类型容量
- 无效或缺失 API 钥匙
- API 钥匙未正确 Base64 编码 Authorization 标题
- 丢失的
Authorization: 基本的标题
- 服务器端处理错误
- 条形码生成失败
错误响应格式:
{
"error": "Error message describing what went wrong"
}
回复格式详情
重要的: 这 API 返回二进制图像数据(PNG (默认格式),而不是 JSON。
响应结构:
- Content-Type:
image/png(或相应的图像 MIME 类型) - 回复机构二值图像数据
图像格式:
- 默认格式: PNG
- 条形码图像可直接使用、下载或集成。
保存图像:
JavaScript/Node.js:
const response = await fetch(url, options);
const blob = await response.blob();
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = 'barcode.png';
a.click();
Python:
response = requests.post(url, json=payload, headers=headers)
if response.status_code == 200:
with open('barcode.png', 'wb') as f:
f.write(response.content)
C#:
var response = await httpClient.PostAsync(url, content);
if (response.IsSuccessStatusCode)
{
var imageBytes = await response.Content.ReadAsByteArrayAsync();
await File.WriteAllBytesAsync("barcode.png", imageBytes);
}
请求示例
标题
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
笔记:
- 获得你的 API 钥匙 PDF4me 仪表板
- 这 API 关键必须是 Base64 编码后以“Basic”为前缀 Authorization 标题
- 例如:如果你的 API 关键是
abc123将其编码为 Base64 并使用Authorization: Basic YWJjMTIz
有效载荷
例子:
{
"text": "PDF4me Create Barcode Sample",
"barcodeType": "qrCode",
"hideText": false,
"async": true
}
代码示例
这 PDF4me 创建条形码 REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
行业应用案例及应用
- E-commerce & Retail
- Logistics & Shipping
- Healthcare & Medical
- Government & Compliance
- Education & Libraries
- Business & Finance
电子商务与零售应用案例
- 产品标签使用条形码类型参数生成用于产品包装和标签的独立条形码图像
- 价格标签通过文本参数创建用于动态定价和自动结账系统的条形码图像
- 库存管理:根据文件名规范生成用于仓库管理和库存控制的条形码图像
- 产品目录使用以下方式创建用于产品识别和目录系统的条形码图像 API 一体化
物流与运输应用案例
- 运输标签使用条形码类型参数生成用于包裹跟踪和交付的独立条形码图像
- 包裹识别:通过文本参数为供应链中的每批货物创建唯一的条形码图像
- 仓储系统:生成用于货位定位和库存跟踪的条形码图像,并指定文件名
- 供应链:创建条形码图像,用于通过分销网络跟踪产品 API 一体化
医疗保健应用案例
- 患者身份识别使用条形码类型参数生成用于患者腕带和医疗记录的条形码图像
- 药物追踪通过文本参数创建用于药品识别和剂量验证的条形码图像
- 设备管理:生成用于医疗设备和资产跟踪的条形码图像,并指定文件名
- 实验室样本追踪:使用以下方式创建用于测试样品和结果识别的条形码图像 API 一体化
政府及合规应用案例
- 身份证件使用条形码类型参数生成驾驶执照、护照和身份证的条形码图像
- 表单处理通过文本参数创建用于税务表格和合规文件的条形码图像
- 文件跟踪:生成用于监管跟踪和审计追踪的条形码图像,并指定文件名
- 公共记录使用以下方式创建用于政府文件识别系统的条形码图像 API 一体化
教育与图书馆应用案例
- 学生证使用条形码类型参数生成用于学生身份识别和校园访问的条形码图像
- 图书馆系统通过文本参数创建用于图书识别和借阅系统的条形码图像
- 考试安全:生成用于测试文档识别和完整性的条形码图像,并指定文件名。
- 校园服务:使用以下方式创建用于设备和资源跟踪的条形码图像 API 一体化
商业与金融应用案例
- 发票系统使用条形码类型参数生成用于自动发票处理和付款的条形码图像
- 文档管理:通过文本参数创建用于业务文档识别的条形码图像
- 资产追踪:根据文件名规范生成设备和资产管理系统的条形码图像
- 合规文件使用以下方式创建用于审计跟踪和财务记录的条形码图像 API 一体化