如何在 PDF 文件中遮蔽區域

查克尼思·賓
查克尼思·賓
2024年10月17日
已更新 2024年12月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,請按照以下鏈接進行設置:

本地託管

[POST] 区域遮蔽 API

[POST] Redact Region API 端點允許您使用真正的編輯功能隱藏 PDF 文件特定區域內的敏感信息。 此功能對於管理機密文件的應用程式至關重要,例如法律合同、醫療記錄或財務報表。 透過使用此 API,您可以確保 PDF 中指定區域內的敏感文本被永久刪除,從而提供安全性和合規性。

請注意
一旦區域被編輯,該區域內的內容將無法恢復。

在 Swagger 中試用

Swagger 是一個強大的工具,讓開發人員能夠通過用戶友好的網頁介面與 RESTful API 進行互動。 無論您使用的是 Python、Java 或其他語言,Swagger 都提供了一種便捷的方法來測試和實施這個 API。

使用 Swagger 紅線劃掉區域的步驟

  1. 訪問 Swagger UI:

    如果你的 API 伺服器在本地運行,可以在網頁瀏覽器中導航至 http://localhost:8080/swagger/index.html 來訪問 Swagger。

    Swagger 文檔

  2. 尋找 [POST] 修訂區域 API:

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

    遮蔽區域

  3. 指定編輯坐標:

    在此範例中,我們將從 PDF 中的頁索引 1(即第 2 頁)移除一個表格。 使用以下座標來定義遮蔽區域:

    • 頁索引(特定頁面):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 方面擁有豐富的專業知識,協助改進軟體並支持客戶。他從用戶互動中獲得的洞察力有助於提高產品、文檔和整體體驗。