Wie man Bereiche in PDF-Dateien schwärzt

Chaknith Bin
Chaknith Bin
17. Oktober 2024
Aktualisiert 17. Dezember 2024
Teilen Sie:
This article was translated from English: Does it need improvement?
Translated
View the article in English

Das Schwärzen sensibler Informationen in PDF-Dokumenten ist entscheidend, um die Privatsphäre zu gewährleisten und die Einhaltung von Datenschutzbestimmungen sicherzustellen. Die [POST] Redact Region API von IronSecureDoc bietet eine effiziente Möglichkeit, vertrauliche Texte und Informationen in bestimmten Bereichen eines PDF-Dokuments mithilfe echter Schwärzung zu verbergen. Diese API stellt sicher, dass die geschwärzten Daten vollständig entfernt werden und nicht wiederhergestellt werden können, was sie ideal für den Umgang mit vertraulichen Informationen in juristischen, finanziellen oder persönlichen Dokumenten macht.

Ziehen und Starten von IronSecureDoc

Wenn Sie IronSecureDoc noch nicht gestartet haben, folgen Sie bitte den unten stehenden Links, um es einzurichten:

Lokal hostenIn die Cloud bereitstellen

Die [POST] Redact Region API

Der [POST] Redact Region API-Endpunkt ermöglicht es Ihnen, sensible Informationen in bestimmten Bereichen eines PDF-Dokuments mithilfe echter Schwärzung zu verbergen. Diese Funktion ist entscheidend für Anwendungen, die vertrauliche Dokumente verwalten, wie z. B. juristische Verträge, medizinische Unterlagen oder Finanzberichte. Durch die Nutzung dieser API können Sie sicherstellen, dass sensible Texte in definierten Bereichen eines PDF dauerhaft entfernt werden, was sowohl Sicherheit als auch Compliance bietet.

Bitte beachten Sie
Sobald ein Bereich geschwärzt ist, kann der Inhalt in diesem Bereich nicht wiederhergestellt werden.

In Swagger ausprobieren

Swagger ist ein leistungsstarkes Werkzeug, das Entwicklern ermöglicht, über eine benutzerfreundliche Web-Oberfläche mit RESTful-APIs zu interagieren. Egal, ob Sie Sprachen wie Python, Java oder andere verwenden, Swagger bietet eine bequeme Möglichkeit, diese API zu testen und zu implementieren.

Schritte zum Schwärzen eines Bereichs mit Swagger

  1. Zugriff auf die Swagger-Oberfläche:

    Wenn Ihr API-Server lokal läuft, können Sie Swagger aufrufen, indem Sie in Ihrem Webbrowser zu http://localhost:8080/swagger/index.html navigieren.

    Swagger-Dokumentation

  2. Lokalisieren Sie die [POST] Redact Region API:

    Innerhalb des Swagger UI finden Sie den Endpunkt [POST] /v1/document-services/pdfs/redact-region.

    Bereiche schwärzen

  3. Schwärzungskoordinaten angeben:

    In diesem Beispiel entfernen wir eine Tabelle aus dem PDF auf Seitenindex 1 (d.h. Seite #2). Verwenden Sie die folgenden Koordinaten, um den Schwärzungsbereich festzulegen:

    • Seitenindex (spezifische_Seiten): 1
    • X-Koordinate (region_to_redact_x): 60
    • Y-Koordinate (region_to_redact_y): 270
    • Breite (region_to_redact_w): 470
    • Höhe (region_to_redact_h): 200
  4. Optionale Parameter festlegen:

    Optional können Sie ein Benutzer- oder Besitzerpasswort hinzufügen, bestimmte Seiten angeben oder entscheiden, ob ein schwarzer Kasten über den redigierten Bereich gezeichnet wird, und das Dokument mit PDF/A- oder PDF/UA-Konformität speichern.

    Eingabe-Swagger

  5. Laden Sie ein Beispiel-PDF hoch:

    Laden Sie im Anfragekörper eine Beispiel-PDF-Datei hoch, auf die Sie die Schwärzung anwenden möchten. Stellen Sie sicher, dass die Datei als pdf_file hinzugefügt wird.

  6. Die Anforderung ausführen:

    Klicken Sie auf "Ausführen", um die Anforderung auszuführen. Die Antwort wird das redigierte PDF enthalten, bei dem die Tabelle auf Seitenindex 1 wie angegeben entfernt wurde.

    Antwort

    Diese Swagger-UI-Interaktion ermöglicht es Ihnen, den Schwärzungsprozess einfach zu testen und bietet sofortiges Feedback darüber, wie die Koordinaten den PDF-Inhalt beeinflussen.

  7. Überprüfen Sie die Ausgabedatei:

    Der geschwärzte Bereich wird sich auf Seite 2 befinden.


Verstehen der Eingabeparameter

Bevor Sie diese API verwenden, ist es wichtig, die erforderlichen und optionalen Eingabeparameter für die Schwärzung eines Bereichs in Ihrem PDF zu verstehen. Diese Parameter helfen, den spezifischen Bereich zu definieren, der geschwärzt werden soll.

Wichtige Parameter

  • pdf_file: Das PDF-Dokument, das Sie redigieren möchten.
  • region_to_redact_x: X-Koordinate des Bereichs, der unkenntlich gemacht werden soll (ausgehend von der unteren linken Ecke der Seite).
  • region_to_redact_y: Y-Koordinate des Bereichs, der redigiert werden soll (beginnend von der unteren linken Ecke der Seite).
  • region_to_redact_w: Breite des zu schwärzenden Bereichs.
  • region_to_redact_h: Höhe des zu redigierenden Bereichs.

Optionale Parameter

  • user_password: Wenn das PDF passwortgeschützt ist, geben Sie das Benutzerpasswort an.
  • owner_password: Geben Sie das Besitzerpasswort an, wenn Änderungen eingeschränkt sind.
  • specific_pages: Geben Sie an, welche Seiten geschwärzt werden sollen. Falls nicht angegeben, gilt die Schwärzung für alle Seiten.
  • save_as_pdfa: Speichern Sie das PDF mit PDF/A-3-Konformität.
  • save_as_pdfua: Speichern Sie das PDF mit PDF/UA-Konformität.

API-Integration: Python-Beispiel

Sobald Sie mit den Parametern vertraut sind, können Sie diese API mit Ihrer bevorzugten Programmiersprache aufrufen. Nachfolgend finden Sie ein Beispiel, wie Sie diese API mit Python integrieren können.

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

Dieser Code führt die folgenden Schritte aus:

  • PDF laden: Die zu schwärzende PDF-Datei wird aus dem lokalen Dateisystem geladen.
  • Festlegen der Schwärzungsparameter: Geben Sie die Koordinaten (X, Y), die Breite, die Höhe und die spezifische Seite zum Schwärzen an.
  • API aufrufen: Die [POST] Redact Region API wird aufgerufen und die erforderlichen Parameter werden übergeben.
  • Speichern Sie das Ergebnis: Die bearbeitete PDF-Datei wird als neue Datei gespeichert.

    Der angegebene Bereich ist wie unten gezeigt geschwärzt.

    Geschwärzter Output

Chaknith Bin
Software-Ingenieur
Chaknith arbeitet an IronXL und IronBarcode. Er hat tiefgehende Expertise in C# und .NET und hilft, die Software zu verbessern und Kunden zu unterstützen. Seine Erkenntnisse aus Benutzerinteraktionen tragen zu besseren Produkten, Dokumentation und einem insgesamt besseren Erlebnis bei.