1. IronSecureDoc
  2. 如何使用
  3. 重編文本

如何使用 IronSecureDoc 在 C# PDF 中編輯文本

Curtis Chau
Curtis Chau
更新:
This article was translated from English: Does it need improvement?
Translated
View the article in English

本文將討論如何使用 IronSecureDoc 對 PDF 中的文字進行編輯。 這樣，服務或流程就可以透過向正在執行的 IronSecureDoc 伺服器發出包含 PDF 的簡單 POST 請求，快速輕鬆地編輯敏感資訊。 我們將透過使用 Swagger 文件來直觀地展示這一點。 POST 請求可以接受必需參數和可選參數，並且具有高度可自訂性； 回應返回包含已編輯文字的 PDF 檔案。

如何使用 IronSecureDoc 對 PDF 中的文字進行編輯

  1. 拉取並啟動 IronSecureDoc Docker 映像
  2. 使用 Swagger 測試 API
  3. 指定要遮蔽的文本
  4. 使用提供的詳細信息執行 API 調用
  5. 導出已遮蔽的 PDF 文檔

拉取並啟動 IronSecureDoc

如果您尚未執行 IronSecureDoc，請點擊以下連結進行安裝：

本地托管 部署到雲端

[POST] 編輯文字 API

[POST] 編輯文字 API 端點可讓您使用編輯功能隱藏 PDF 文件中的敏感文字。 對於處理機密文件（例如法律合約、醫療記錄或財務報告）的應用程式而言，此功能至關重要。 使用此 API 可確保永久刪除特定文本，從而提高安全性並確保符合資料保護標準。

一旦文字被編輯，其內容將無法恢復。

昂首闊步

Swagger 是一款強大的工具，它使開發人員能夠透過使用者友好的 Web 介面與 RESTful API 進行互動。 無論你使用 Python、Java 或其他語言，Swagger 都提供了一種方便的方法來測試和實作此 API。

使用 Swagger 編輯文字的步驟

1.存取 Swagger 使用者介面：

如果您的 API 伺服器在本機上運行，您可以透過在 Web 瀏覽器中存取http://localhost:8080/swagger/index.html來存取 Swagger。

！ Swagger 文件

2.找到 [POST] 編輯文字 API：

在 Swagger UI 中，找到 [POST] /v1/document-services/pdfs/redact-text 端點。

！已編輯文字

3.指定配置：

在這個例子中，我同時提供了PDF文件和需要在POST請求中隱藏的文字。我們將隱藏單字"we"，並在其上方疊加一個黑框。 在本次示範中，我們將使用具有以下配置的" sample.pdf "檔案：

  • 繪製黑盒 : true
  • 匹配整個單字 : true
  • 待編輯的文字 ：我們

4.上傳範例 PDF 檔：

在請求正文中，上傳一個需要進行編輯的範例 PDF 檔案。 確保將文件新增為pdf文件 。

5.執行請求：

點擊"執行"按鈕運行請求。回應結果將包含已編輯的 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文件=@sample.pdf;type=應用程式/pdf' \
 -F '待編輯的文字="we"' \
 -F '繪製黑盒=true' \
 -F '匹配整個單字=true'
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
 -H 'accept: */*' \
 -H 'Content-Type: multipart/form-data' \
 -F 'pdf文件=@sample.pdf;type=應用程式/pdf' \
 -F '待編輯的文字="we"' \
 -F '繪製黑盒=true' \
 -F '匹配整個單字=true'
SHELL

[{i:( 預設情況下，PowerShell 可能會將curl解釋為Invoke-WebRequest的別名，Invoke-WebRequest 是 PowerShell 內建 cmdlet。 嘗試使用curl.exe而不是curl 。

curl.exe --version
curl.exe --version
SHELL

@@--括號關閉--@@

必需的請求體參數

請輸入您的姓名 資料類型 描述
pdf文件 應用程式/pdf 您要編輯的PDF文件。
待編輯的文字 array[細繩] 此參數接受一個單字列表，並刪除與輸入相符的文字。

可選的請求體參數

請輸入您的姓名 資料類型 描述
使用者密碼 細繩 如果輸入的 PDF 檔案設定了使用者密碼，則必須輸入密碼。如果未為受密碼保護的 PDF 檔案提供密碼，操作將會失敗。
所有者密碼 細繩 如果輸入的 PDF 檔案設定了所有者密碼，則必須執行此操作。如果未為受密碼保護的 PDF 檔案提供密碼，則操作將會失敗。
特定頁面 array[int] 允許您指定要隱藏哪些頁面上的文字。預設情況下，該值為空，表示所有頁面中的指定詞語都將被隱藏。
繪製黑盒 布林值 允許您指定是否在已編輯的文字上繪製黑框。預設情況下，此值設定為 True。
匹配整個單字 布林值 指定是否也應刪除單字中的部分匹配項。例如，如果提供的單字是"are"，則任何包含"are"的單字（例如"hare"）中的"are"也會被刪除。預設情況下，此設定設為 True。
區分大小寫 布林值 指定提供的單字是否需要完全匹配（區分大小寫）。預設值為 null。注意：設定為 True 表示將不符合大小寫字串。例如，如果提供的單字是"WE"，則不會刪除小寫形式的"we"。
疊加文字 細繩 它指定覆蓋在已編輯文字上的文字，例如單字或符號。預設情況下，此字串為空。
儲存為pdf 布林值 儲存符合 PDF/A-3 標準的修改後 PDF 檔案。預設情況下，此選項設定為"否"。
保存為pdfua 布林值 儲存符合 PDF/UA 規範的修改後 PDF 檔案。預設情況下，此項設定為"否"。

可選的頭部參數

請輸入您的姓名 資料類型 描述
作者 細繩 用於識別您是 PDF 文件的作者。預設情況下，此欄位為空。
標題 細繩 顯示PDF文件的標題。預設情況下，此欄位為空。
主題 細繩 方便快速辨識 PDF 文件的內容。預設情況下，此欄位為空。

常見問題解答

如何使用 POST 請求刪除 PDF 中的文字？

您可以透過向 IronSecureDoc 伺服器提出 POST 請求，並附上 PDF 檔案和要刪除的文字，來刪除 PDF 中的文字。伺服器會處理請求，並傳回經刪除文字的 PDF。

使用 IronSecureDoc API 進行 PDF 節錄的步驟為何？

若要使用 IronSecureDoc API 進行 PDF 編輯，您應該先拉取並啟動 IronSecureDoc Docker Image，使用 Swagger 測試 API，指定要編輯的文字，執行 API 呼叫，最後匯出經編輯的 PDF 文件。

在生產中使用 IronSecureDoc API 之前，我該如何測試？

您可以存取 Swagger UI 來使用 Swagger 測試 IronSecureDoc API，您可以使用提供的端點來模擬編輯流程。

在 PDF 編輯請求中可以自訂哪些參數？

在 PDF 編輯請求中，您可以自訂參數，例如 user_password、owner_password、specific_pages、draw_black_box、match_whole_word、match_case、overlay_text、save_as_pdfa 及 save_as_pdfua，以進一步自訂。

如何使用 curl 執行 PDF 編輯請求？

要使用 curl 執行 PDF 編輯請求，您可以使用 curl POST 請求指令，在指令提示中指定必要的參數和檔案路徑。

如果我的 PDF 在編輯時受到密碼保護，該怎麼辦？

如果您的 PDF 受密碼保護，您需要在可選參數中包含 user_password 或 owner_password，以確保重編過程能夠存取並修改文件。

文字編輯中的 'draw_black_box' 參數有何作用？

draw_black_box」參數指定是否以黑框覆蓋刪除的文字。此選項有助於可視化刪除的區域，預設為啟用。

如何在本機託管 IronSecureDoc 以進行編輯？

您可以按照提供的教程在本機託管 IronSecureDoc，適用於 Windows、Mac 或 Linux 等各種作業系統，讓您可以在本機伺服器上管理編輯過程。

是否可以刪除 PDF 中的特定頁面？

是的，您可以使用「specific_pages」參數指定要刪除的頁面，這可讓您針對文件的特定區域進行刪除。

我可以在 PDF 中的刪除區域覆蓋文字嗎？

是的，您可以使用「overlay_text」參數在刪除區域上覆蓋文字，這可讓您使用自訂訊息或占位符取代刪除的文字。

IronSecureDoc 是否與 .NET 10 及其用戶端程式庫相容？

是的，IronSecureDoc 透過 NuGet 套件 IronSoftware.SecureDoc.Client 提供 .NET 用戶端，而且除了 .NET 6-9 等先前版本外，還與 .NET 10 相容。這可確保您能在 .NET 10 應用程式中無縫整合編輯及相關 API。

Curtis Chau
Curtis Chau
  立即與工程團隊聊天
技術作家

Curtis Chau 擁有卡爾頓大學計算機科學學士學位，專注於前端開發，擅長於 Node.js、TypeScript、JavaScript 和 React。Curtis 熱衷於創建直觀且美觀的用戶界面，喜歡使用現代框架並打造結構良好、視覺吸引人的手冊。

除了開發之外，Curtis 對物聯網 (IoT) 有著濃厚的興趣，探索將硬體和軟體結合的創新方式。在閒暇時間，他喜愛遊戲並構建 Discord 機器人，結合科技與創意的樂趣。

準備好開始了嗎？
Version: 2024.10 剛發表