如何重制 PDF 文件中的区域

查克尼特·宾
查克尼特·宾
2024年十月17日
更新 2024年十二月17日
分享:
This article was translated from English: Does it need improvement?
Translated
View the article in English

编辑 PDF 文档中的敏感信息对于确保隐私和遵守数据保护法规至关重要。 IronSecure Doc的[POST] Redact Region API提供了一种有效的方法,通过真正的修订来隐藏PDF文档中特定区域的敏感文本和信息。 该 API 可确保完全删除经编辑的数据,且无法恢复,因此非常适合处理法律、财务或个人文件中的机密信息。

拉动并启动 IronSecureDoc

如果您还没有运行 IronSecureDoc,请按照以下链接进行设置:

Host LocallyDeploy to Cloud

POST] Redact Region API

[POST] Redact Region API 端点允许您使用真正的编辑功能隐藏 PDF 文档中特定区域的敏感信息。 这一功能对于管理法律合同、医疗记录或财务报表等机密文件的应用程序至关重要。 利用此 API,您可以确保永久删除 PDF 定义区域内的敏感文本,从而实现安全性和合规性。

请注意
一旦某个区域被编辑,该区域内的内容将无法恢复。

在 Swagger 中试用

Swagger 是一款功能强大的工具,可帮助开发人员通过用户友好的 Web 界面与 RESTful API 进行交互。 无论您使用的是 Python、Java 还是其他语言,Swagger 都能为您提供测试和实现该 API 的便捷方法。

使用 Swagger 重制区域的步骤

  1. 访问 Swagger UI:

    如果您的 API 服务器在本地运行,您可以通过在 Web 浏览器中导航到 http://localhost:8080/swagger/index.html 访问 Swagger。

    Swagger 文档

  2. 定位 [POST] Redact Region API:

    在 Swagger UI 中,找到 [POST] /v1/document-services/pdfs/redact-region 端点。

    编辑区域

  3. 指定修订坐标:

    在此示例中,我们将从页面索引为1的PDF中移除一个表格(即,第2页)。 使用以下坐标定义节录区域:

    • 页面索引(specific_pages):1
    • X 坐标 (region_to_redact_x): 60
    • Y 坐标 (region_to_redact_y):270
    • 宽度 (region_to_redact_w):470
    • 高度 (region_to_redact_h): 200
  4. 设置可选参数:

    您可以选择添加用户或所有者密码,指定特定页面,或决定是否在编辑区域上画一个黑框,并以 PDF/A 或 PDF/UA 合规性保存文档。

    输入 Swagger

  5. 上传示例 PDF:

    在请求正文中,上传您要应用编辑的 PDF 样本文件。 确保将文件添加为pdf_file

  6. 执行请求:

    单击 "执行 "运行请求。响应将包括经编辑的 PDF,并按照指定删除索引 1 页中的表格。

    响应

    这种 Swagger UI 交互方式可让您轻松测试编辑过程,即时反馈坐标对 PDF 内容的影响。

  7. 检查输出 PDF:

    节录区域将位于第 2 页。


理解输入参数

在使用此 API 之前,必须了解在 PDF 中编辑区域所需和可选的输入参数。 这些参数有助于确定需要编辑的特定区域。

关键参数

  • pdf_file: 您要编辑的PDF文档。
  • region_to_redact_x: 要编辑区域的 X 坐标(从页面左下角开始)。
  • region_to_redact_y:要编辑区域的 Y 坐标(从页面的左下角开始)。
  • region_to_redact_w: 要遮蔽的区域的宽度。
  • region_to_redact_h: 要编辑区域的高度。

可选参数

  • user_password:如果 PDF 受密码保护,请提供用户密码。
  • owner_password:如果限制了修改,请提供所有者密码。
  • specific_pages:指定要编辑的页面。 如果未提供,则节录适用于所有页面。
  • save_as_pdfa: 保存符合 PDF/A-3 的 PDF。
  • save_as_pdfua:保存符合 PDF/UA 标准的 PDF。

API 集成:Python 示例

熟悉参数后,您就可以使用自己喜欢的编程语言调用此 API。 下面是一个如何使用 Python 集成此 API 的示例。

import requests

url = 'http://localhost:8080/v1/document-services/pdfs/redact-region'
headers = {
    'accept': '*/*',
    'author': 'IronSoftware',
    'title': 'REDACT REGION DEMO 2024',
    'subject': 'DEMO EXAMPLE'
}

# Open the file
files = {
    'pdf_file': ('sample_file.pdf', open('sample_file.pdf', 'rb'), 'application/pdf')
}

# Prepare the argument
data = {
    'region_to_redact_x': '60',
    'region_to_redact_y': '270',
    'region_to_redact_w': '470',
    'region_to_redact_h': '200',
    'specific_pages':[1]
}

# Call the API
response = requests.post(url, headers=headers, files=files, data=data)

# Save the redacted PDF
with open('redacted_output.pdf', 'wb') as f:
    f.write(response.content)

print('PDF redacted successfully.')
PYTHON

本《代码》执行以下步骤:

  • 加载PDF:要编辑的PDF文件从本地文件系统中加载。
  • 设置涂销参数:指定要涂销的坐标(X, Y)、宽度、高度和特定页面。
  • 调用 API:调用 [POST] Redact Region API,传入必要的参数。
  • 保存结果:编辑后的 PDF 另存为一个新文件。

    给定区域已编辑,如下所示。

    已编辑的输出

查克尼特·宾
软件工程师
Chaknith 负责 IronXL 和 IronBarcode 的工作。他在 C# 和 .NET 方面拥有深厚的专业知识,帮助改进软件并支持客户。他从用户互动中获得的洞察力,有助于提升产品、文档和整体体验。