读取条形码 PDF 扫描仪和提取器 API

PDF4me 读取条形码 PDF 使您能够提取和识别各种类型的条形码， QR codes 从 PDF 使用高级文档 OCR 以及条形码识别技术。这 API 服务流程 PDF 文件和提取条形码数据，包括位置坐标、类型信息和提取的文本。 API 接收 PDF 通过内容 REST API 利用电话 Base64 用于安全传输的编码。支持一维和二维条形码，包括 QR codes， DataMatrix， PDF417， Code128该解决方案支持各种专业行业格式，是文档处理、库存管理、跟踪系统和工作流程自动化的理想选择。

相关博客文章

目前尚无关于此功能的博客文章——敬请期待。

在此期间，您可以浏览 PDF4me 博客，查看适用于各平台的教程和工作流程。

访问博客 →

验证您的身份 API 要求

要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全，并验证您作为授权用户的身份。 REST API。

Get your api Key

主要特点

• 全面条形码识别支持一维和二维条形码，包括 QR codes， DataMatrix， PDF417， Code128邮政编码和专业行业格式
• 无缝的 PDF 一体化直接加工 PDF 支持所有文档 PDF 版本和复杂的文档结构
• 灵活页面处理：处理特定页面、页面范围或整个文档，并具备选择性条形码提取功能
• 企业批量处理利用自动化处理工作流程从单个或多个页面中提取多个条形码
• 结构化数据输出以结构化格式返回条形码数据 JSON 格式包含位置坐标、类型信息和元数据，便于系统集成

支持的条形码类型

这 API 支持多种条形码格式，实现可靠识别：

一维条形码

• Code128 通用条形码格式
• Code39 - 字母数字条形码
• Code93 高密度条形码
• Codabar 数字条形码
• EAN8/EAN13 欧洲商品编号
• UPC-A/UPC-E - 通用产品代码
• Inter2of5 - 工业 2/5
• PatchCode - 文档处理代码

二维条形码

• QR Code 快速响应码
• DataMatrix 高密度二维条形码
• PDF417 - 便携式数据文件
• MicroQRCode - 袖珍的 QR 变体

专业格式

• 邮政编码： Postnet， Planet， RM4SCC， Australia Post
• 智能邮件： USPS 智能邮件条形码
• PharmaCode药品条形码
• RSS Codes：简化空间符号学

REST API 端点

这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有条形码读取操作均通过单个端点执行：

• 方法： POST
• 终点： /api/v2/ReadBarcodes

REST API 参数

读取条形码的完整参数列表 PDF REST API参数按类别组织，以便更好地理解和实施。

重要的： 标有星号 (*) 的参数为必填项，必须提供。 API 正常运作。

必需参数

范围	类型	描述	例子
docContent*	Base64	PDF 文件内容以编码形式 Base64	JVBERi...
docName*	String	PDF 文件名带有 .pdf 扩展名	document.pdf
barcodeType*	Array	要检测的条形码类型数组。 ["all"] 适用于所有类型，或特定类型，例如 ["qrCode"]， ["dataMatrix", "code128"]	["all"]
页面*	String	页面选项：“全部”、“1”、“1,3,5”、“2-5”、“1,3,7-10”、“2-”	all
IsAsync*	Boolean	启用异步处理。 true， 这 API 返回 202 状态并提供轮询 URL 在 Location 标题	true

条形码类型选项

类型	描述	类别
all	检测所有支持的条形码类型	普遍的
unknown	检测未知条形码类型	普遍的
qrCode	QR Code 认出	二维
dataMatrix	DataMatrix 认出	二维
pdf417	PDF417 认出	二维
code128	Code128 认出	1D
code39	Code39 认出	1D
ean13	EAN13 认出	1D
upca	UPC-A 认出	1D
all_1D	所有一维条形码类型	1D
all_2D	所有二维条码类型	二维

输出

这 PDF4me 读取条形码 PDF REST API 根据处理模式的不同，会返回不同的响应。 API 收益结构 JSON 包含条形码信息的数据。

Success Response

同步处理（默认）

什么时候 IsAsync 未设置或已设置为 false， 这 API 立即处理请求：

状态码： 200 OK

Content-Type： application/json

回复正文：

{
  "barcodes": [
    {
      "type": "qrCode",
      "text": "Barcode content",
      "page": 1,
      "x": 100,
      "y": 200,
      "width": 50,
      "height": 50
    }
  ]
}

回复字段：

• 条形码 （数组）：检测到的条形码对象数组
  • 类型 （字符串）：条形码类型（例如，“qrCode“，“dataMatrix“，“code128）
  • 文本 （字符串）：提取的条形码内容/文本
  • 页 （数字）：条形码所在的页码
  • x （数字）：条形码位置的 X 坐标
  • 和 （数字）：条形码位置的 Y 坐标
  • 宽度 （数字）：条形码的宽度
  • 高度 （数值）：条形码高度

例子 （JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
data.barcodes.forEach(barcode => {
  console.log(`Found ${barcode.type}: ${barcode.text} on page ${barcode.page}`);
});

Asynchronous Processing

异步处理

什么时候 IsAsync: true 已设定， API 异步处理请求：

状态码： 202 Accepted

响应头：

Location: https://api.pdf4me.com/api/v2/ReadBarcodes/poll/12345-abcde-67890

投票过程：

1. 提取 Location 来自 202 响应的标头
2. 民意调查 URL 使用 GET 请求
3. 继续轮询，直到收到 200 OK 地位
4. 最终回复包含相同的内容。 JSON 条形码数据格式

轮询示例：

// 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 data = await pollResponse.json();
    // Process data.barcodes array
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

错误响应

这 API 退货标准 HTTP 错误代码及错误详情：

400 Bad Request

• 无效的请求参数
• 缺少必填字段文档内容， 文档名称， 条形码类型， 页面， IsAsync）
• 无效的 Base64 编码 文档内容
• 无效的条形码类型数组格式
• 无效的页面规范

401 Unauthorized

• 无效或缺失 API 钥匙
• API 密钥不正确 Base64 编码 Authorization 标题
• 丢失的 Authorization： 基本的 标题

500 Internal Server Error

• 服务器端处理错误
• PDF 处理失败
• 条形码识别失败

错误响应格式：

{
  "error": "Error message describing what went wrong"
}

Response Format Details

回复格式详情

重要的： 这 API 总是返回 JSON 使用结构化条形码数据。

响应结构：

{
  "barcodes": [
    {
      "type": "string",      // Barcode type
      "text": "string",       // Extracted barcode content
      "page": number,         // Page number (1-based)
      "x": number,            // X coordinate
      "y": number,            // Y coordinate
      "width": number,        // Barcode width
      "height": number        // Barcode height
    }
  ]
}

Content-Type 标题：

• 成功： application/json

结果为空： 如果未找到条形码，则响应将包含一个空数组：

{
  "barcodes": []
}

多个条形码： 这 API 可以检测同一页面或不同页面上的多个条形码。所有检测到的条形码都包含在内。 barcodes 大批。

请求示例

标题

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

笔记：

• 获得你的 API 钥匙 PDF4me 仪表板
• 这 API 关键必须是 Base64 编码后以“Basic”为前缀 Authorization 标题
• 例如：如果你的 API 关键是 abc123将其编码为 Base64 并使用 Authorization: Basic YWJjMTIz

有效载荷

例子：

{
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "docName": "document.pdf",
  "barcodeType": ["all"],
  "pages": "all",
  "IsAsync": true
}

代码示例

这 PDF4me 读取条形码 PDF REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言：

C#

C# （CSharp） 样本

完全的 C# 实现从 PDF 文件：

View C# Sample

Java

Java 样本

Java 实现了完整的错误处理和响应处理功能：

View Java Sample

JavaScript

JavaScript 样本

Node.js 并且与浏览器兼容 JavaScript 执行：

View JavaScript Sample

Python

Python 样本

Python 使用 requests 库实现 JSON 处理：

View Python Sample

Salesforce

Salesforce 样本

Salesforce Apex 实施 CRM 一体化：

View Salesforce Sample

n8n

n8n 样本

n8n 自动化工作流程实施：

View n8n Sample

Google Script

Google Script 样本

Google Apps Script 实施 Google Workspace 一体化：

View Google Script Sample

AWS Lambda

AWS Lambda 样本

无服务器 AWS Lambda 函数实现：

View AWS Lambda Sample

行业应用案例及应用

Finance & Banking

金融与银行业应用案例

• 发票处理从发票中提取条形码数据，用于自动支付处理
• 财务文件：处理带有条形码的财务文件以进行支付处理
• 支付处理从财务单据中的条形码提取支付信息
• 银行一体化将条形码读取功能集成到银行应用程序和系统中

Business & Enterprise

商业及企业应用案例

• 库存管理读取产品条形码 PDF 股票跟踪文件
• 供应链管理通过从条形码提取数据来跟踪产品 PDF 文件
• 数据集成：整合来自 PDFs 进入业务系统
• 文档自动化自动从扫描文档中提取条形码数据
• 工作流自动化：在文档管理系统中自动提取条形码数据
• 业务流程自动化：实现企业运营的条形码处理工作流程自动化

E-commerce & Retail

电子商务与零售应用案例

• 产品跟踪读取产品条形码 PDF 库存管理文件
• 订单处理从订单文档中提取条形码数据以进行处理
• 质量控制：使用条形码数据验证产品信息 PDF 报告
• 供应链管理通过从条形码提取数据来跟踪产品 PDF 文件

Government & Compliance

政府及合规应用案例

• 合规性监控从合规文件中提取跟踪代码
• 监管文件：处理带有条形码的监管文件
• 政府文件从政府文件中提取条形码数据
• 公共记录处理带有条形码信息的公共记录

Technology & Development

技术与开发应用案例

• API 一体化将条形码读取功能集成到现有文档处理工作流程中
• 批量处理处理大量 PDF 条形码提取文档
• 数据验证验证从条形码中提取的数据 PDF 文件
• 表单处理从条形码中提取信息 PDF 表格和申请
• 系统集成将条形码读取功能集成到企业系统和工作流程中

条形码识别功能

检测能力

• 多格式支持识别各种格式的一维和二维条形码
• 位置跟踪：带有坐标的精确条形码位置和定位数据
• 页面选择：使用页面选项处理特定页面或整个文档

处理特征

• 批次识别从单个或多个页面中提取多个条形码
• 类型筛选：指定要检测的条形码类型，使用 barcodeType 大批
• 结构化输出返回包含类型、文本、页码和位置信息的条形码数据

获取帮助

Get Your API KeyAPI SamplesGetting Started