如何使用 C# 涂黑 PDF 文件中的区域

Curtis Chau
Curtis Chau
更新: 2026年8月2日

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

拉取并启动 IronSecureDoc

如果您尚未运行 IronSecureDoc,请点击以下链接进行安装:

[POST] 编辑区域 API

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

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

在 Swagger 中尝试一下

Swagger 是一款强大的工具,它使开发人员能够通过用户友好的 Web 界面与 RESTful API 进行交互。 无论你使用 Python、Java 或其他语言,Swagger 都提供了一种便捷的方式来测试和实现此 API。

使用 Swagger 编辑区域的步骤

  1. 访问Swagger UI:

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

    Swagger文档

  2. 找到[POST] /v1/document-services/pdfs/redact-region端点:

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

    编辑区域

  3. 指定编辑坐标:

    在这个例子中,我们将从 PDF 的页面索引 1(即第 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

# Define the API endpoint URL
url = 'http://localhost:8080/v1/document-services/pdfs/redact-region'

# Set the headers for the request (optional relevant metadata)
headers = {
    'accept': '*/*',
    'author': 'Iron Software',
    'title': 'REDACT REGION DEMO 2024',
    'subject': 'DEMO EXAMPLE'
}

# Open the PDF file to be redacted in binary read mode
files = {
    'pdf_file': ('sample_file.pdf', open('sample_file.pdf', 'rb'), 'application/pdf')
}

# Define the coordinates and page for the redaction region
data = {
    'region_to_redact_x': '60',  # X-coordinate starting at the bottom-left
    'region_to_redact_y': '270', # Y-coordinate starting at the bottom-left
    'region_to_redact_w': '470', # Width of the region to be redacted
    'region_to_redact_h': '200', # Height of the region to be redacted
    'specific_pages': [1]        # Specify the page index to redact
}

# Make the POST request to the API with the provided parameters and file
response = requests.post(url, headers=headers, files=files, data=data)

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

print('PDF redacted successfully.')
Python

这段代码执行以下步骤:

  • 加载PDF:要编辑的PDF文件从本地文件系统加载。
  • 设置编辑参数:指定要编辑的坐标(X, Y),宽度,高度,以及特定的页面。
  • 调用API:调用[POST]编辑区域API,并传入必要的参数。
  • 保存结果:编辑后的PDF被保存为一个新文件。

如下所示,给定区域已被隐去。

编辑后输出

常见问题

什么是 [POST] Redact Region API?

IronSecureDoc提供[POST] Redact Region API用于编辑PDF文档中特定区域。它安全地移除敏感信息,确保符合隐私和数据保护法规。

如何开始使用IronSecureDoc?

要开始使用IronSecureDoc,请通过IronSecureDoc Docker设置链接来获取并启动Docker镜像。这样您可以在本地运行该服务或将其部署到云端。

使用IronSecureDoc编辑PDF文件中的区域涉及哪些步骤?

编辑区域的步骤包括获取IronSecureDoc Docker镜像、使用Swagger调用API、设置参数、从您喜欢的编程语言调用API,以及下载编辑后的PDF文档。

我可以选择在PDF中哪些页面进行编辑吗?

是的,当使用IronSecureDoc中的[POST] Redact Region API时,您可以通过'specific_pages'参数指定要编辑的页面。

如何使用API设置编辑坐标?

通过在API请求中指定X和Y坐标、宽度和高度来设置编辑区域,以定义您想要编辑的区域。

哪些可选参数可以增强我的编辑流程?

可选参数包括为受保护的PDF设置用户和所有者密码、指定特定页面进行编辑,以及选择PDF/A或PDF/UA等合规格式。

IronSecureDoc能够保证永久删除编辑数据吗?

是的,IronSecureDoc的真正编辑功能保证编辑数据被完全删除且无法恢复,以确保保密性。

我如何测试[POST] Redact Region API?

您可以使用Swagger通过用户友好的界面与API进行交互,这使您能够测试和实施针对特定PDF文档的编辑过程。

是否可以将IronSecureDoc API集成到使用Python的应用中?

是的,您可以使用Python或其他编程语言集成IronSecureDoc的API,提供必要的参数并与API端点接口。

使用PDF/A或PDF/UA合规选项有什么好处?

在IronSecureDoc中保存具有PDF/A或PDF/UA合规性的编辑PDF可确保文档符合特定长期保存标准和可访问性要求。

Curtis Chau 拥有卡尔顿大学的计算机科学学士学位,专注于前端开发,精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面,喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。

阅读更多

准备开始了吗?

版本:2024.10刚刚发布