如何使用 IronSecureDoc 在 C# 中涂黑 PDF 文本
本文将讨论如何使用 IronSecureDoc 对 PDF 中的文本进行编辑。 这允许服务或进程通过向正在运行的IronSecureDoc服务器发送简单的POST请求,快速且轻松地编辑敏感信息。 我们将通过使用 Swagger 文档来直观地展示这一点。 POST请求包含必需和可选参数,并且高度可定制; 响应返回包含已编辑文本的 PDF 文件。
如何使用 IronSecureDoc 对 PDF 中的文本进行编辑
- 拉取并启动IronSecureDoc Docker镜像
- 使用 Swagger 测试 API
- 指定要编辑的文本
- 使用提供的详细信息执行 API 调用
- 导出编辑后的 PDF 文档
拉取并启动 IronSecureDoc
如果您尚未运行 IronSecureDoc,请点击以下链接进行安装:
[POST] 编辑文本 API
[POST] 编辑文本 API 端点允许您使用编辑功能隐藏 PDF 文档中的敏感文本。 对于处理机密文件(例如法律合同、医疗记录或财务报告)的应用程序而言,此功能至关重要。 使用此 API 可确保永久删除特定文本,从而提高安全性并确保符合数据保护标准。
Swagger
Swagger 是一款强大的工具,它使开发人员能够通过用户友好的 Web 界面与 RESTful API 进行交互。 无论你使用 Python、Java 或其他语言,Swagger 都提供了一种便捷的方式来测试和实现此 API。
使用 Swagger 编辑文本的步骤
-
访问Swagger UI:
如果您的API服务器在本地运行,您可以通过在浏览器中导航到
http://localhost:8080/swagger/index.html来访问Swagger。
-
找到 [POST] Redact Text API:
在Swagger UI中,找到
POST/v1/document-services/pdfs/redact-text端点。
-
指定配置:
在这个例子中,我在
POST请求中提供了PDF文件和要编辑的词。我们将编辑单词“we”并在其上覆盖一个黑色框。 在此演示中,我们将使用带有以下配置的“sample.pdf”文件:draw_black_box:truematch_whole_word:truewords_to_redact:we
-
上传示例PDF:
在请求正文中,上传一个需要进行编辑的示例 PDF 文件。 确保文件已作为
pdf_file添加。 -
执行请求:
点击“执行”按钮运行请求。响应结果将包含已编辑的 PDF 文件。 Swagger UI 交互功能让您可以轻松测试编辑过程,并提供即时反馈。
通过命令提示符使用 CURL 请求
或者,我们可以使用带有curl POST请求的命令提示符来实现相同的结果。
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
-H 'accept: */*' \
-H 'Content-Type: multipart/form-data' \
-F 'pdf_file=@sample.pdf;type=application/pdf' \
-F 'words_to_redact="we"' \
-F 'draw_black_box=true' \
-F 'match_whole_word=true'
curl解释为Invoke-WebRequest的别名,这是一个内置PowerShell cmdlet。 尝试使用curl.exe代替curl。 curl.exe --version
所需请求正文参数
| 名称 | 数据类型 | 说明 |
|---|---|---|
pdf_file | application/pdf | 您要编辑的PDF文件。 |
words_to_redact | array[string] | 此参数接受一个单词列表,并删除与输入匹配的文本。 |
可选的请求体参数
| 名称 | 数据类型 | 说明 |
|---|---|---|
user_password | string | 如果输入的 PDF 文件设置了用户密码,则必须输入密码。如果未为受密码保护的 PDF 文件提供密码,操作将失败。 |
owner_password | string | 如果输入的 PDF 文件设置了所有者密码,则必须执行此操作。如果未为受密码保护的 PDF 文件提供密码,则操作将失败。 |
specific_pages | array[int] | 允许您指定要在其上编辑文本的页面。默认情况下,该值为null,这意味着提供的单词在所有页面中都将被编辑。 |
draw_black_box | boolean | 允许您指定是否在编辑文本上绘制一个黑框。默认情况下,此值设置为True。 |
match_whole_word | boolean | 指定是否也应编辑单词中的部分匹配。例如,如果提供的单词是"are",包含"are"的任何单词(例如"hare")也将编辑掉"are"。默认情况下,此项设置为True。 |
match_case | boolean | 指定提供的单词在大小写上是否应完全匹配。默认情况下,此值为null。注意:将此项设置为True意味着大小写字符串将不匹配。例如,如果提供的单词是"WE",小写版本"we"将不会被编辑。 |
overlay_text | string | 它指定覆盖在已编辑文本上的文字,例如单词或符号。默认情况下,此字符串为空。 |
save_as_pdfa | boolean | 以PDF/A-3兼容性保存修改后的PDF。默认情况下,此项设置为False。 |
save_as_pdfua | boolean | 以PDF/UA兼容性保存修改后的PDF。默认情况下,此项设置为False。 |
可选的头部参数
| 名称 | 数据类型 | 说明 |
|---|---|---|
author | string | 用于识别您是 PDF 文档的作者。默认情况下,此字段为空。 |
title | string | 显示PDF文档的标题。默认情况下,此字段为空。 |
subject | string | 便于快速识别 PDF 文档的内容。默认情况下,此字段为空。 |
常见问题
如何使用 IronSecureDoc 在 PDF 中进行文本删除?
您可以通过向IronSecureDoc服务器发送带有PDF文件的“POST”请求,使用IronSecureDoc进行文本编辑。API允许轻松自定义文本编辑并返回编辑后的PDF。
使用Swagger与IronSecureDoc进行文本编辑的步骤是什么?
要使用Swagger与IronSecureDoc进行文本编辑,您需要访问Swagger UI,找到“POST”编辑文本API,指定要编辑的词语等配置,上传示例PDF,并执行请求以接收编辑后的PDF。
是否可以使用命令提示符与IronSecureDoc进行文本编辑?
是的,您可以通过命令提示符使用“curl”发送“POST”请求,实现IronSecureDoc的文本编辑。请确保请求中包含正确的参数,如“pdf_file”和“words_to_redact”。
IronSecureDoc文本编辑API有哪些可选参数?
IronSecureDoc API的可选参数包括“draw_black_box”、“match_whole_word”、“overlay_text”、“save_as_pdfa”和“save_as_pdfua”,允许您自定义文本编辑的方式。
IronSecureDoc可以编辑PDF文档的特定页面吗?
可以,IronSecureDoc允许指定“specific_pages”以进行文本编辑,提供了精确定位文档特定区域的灵活性。
在PDF中使用IronSecureDoc进行文本编辑的重要性是什么?
IronSecureDoc确保编辑后的文本从PDF中永久删除。这提高了安全性,并符合涉及机密文件的数据保护标准,如法律或财务记录。
我可以本地托管IronSecureDoc还是将其部署在云上?
IronSecureDoc可以在如Windows、Mac和Linux的平台上本地托管,或在Azure和AWS等云服务上部署,以灵活集成。
IronSecureDoc中“draw_black_box”选项的功能是什么?
IronSecureDoc中的“draw_black_box”选项允许您在编辑后的文本上方加一个黑匡进行视觉遮挡,默认情况下启用。
IronSecureDoc是如何处理受密码保护的PDF的?
对于受密码保护的PDF,IronSecureDoc需要“user_password”或“owner_password”参数来执行编辑,以确保授权访问和操作。
可以使用哪些工具与IronSecureDoc的API进行交互?
像Swagger UI这样的工具和命令行工具如“curl”可以与IronSecureDoc的API交互,以测试和实现文本编辑功能。
Curtis Chau 拥有卡尔顿大学的计算机科学学士学位,专注于前端开发,精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面,喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。