1. IronSecureDoc
  2. Anleitungen
  3. Text schwärzen

Wie man Text in C#-PDFs mit IronSecureDoc schwärzt

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

In diesem Artikel geht es um das Schwärzen von Text in einer PDF-Datei mithilfe von IronSecureDoc. Dies ermöglicht es dem Dienst oder Prozess, sensible Informationen schnell und einfach zu schwärzen, indem eine einfache POST-Anfrage mit der PDF-Datei an den laufenden IronSecureDoc-Server gesendet wird. Wir werden dies anhand von Swagger-Dokumenten visuell veranschaulichen. Die POST-Anfrage akzeptiert sowohl erforderliche als auch optionale Parameter und ist hochgradig anpassbar; Die Antwort liefert die PDF-Datei mit dem geschwärzten Text.

So schwärzen Sie Text in PDFs mit IronSecureDoc

  1. Laden Sie das IronSecureDoc Docker-Image herunter und starten Sie es.
  2. Testen Sie die API mit Swagger
  3. Geben Sie den zu schwärzenden Text an
  4. Führen Sie den API-Aufruf mit den bereitgestellten Details aus
  5. Exportieren Sie das geschwärzte PDF-Dokument

Ziehen und starten Sie IronSecureDoc

Falls IronSecureDoc noch nicht installiert ist, folgen Sie bitte den unten stehenden Links zur Einrichtung:

Lokal hosten Bereitstellung in der Cloud

Die [POST] Redact Text API

Mit dem [POST] Redact Text API-Endpunkt können Sie sensible Texte in einem PDF-Dokument mithilfe der Schwärzungsfunktion ausblenden. Diese Funktionalität ist unerlässlich für Anwendungen, die vertrauliche Dokumente wie Rechtsverträge, Krankenakten oder Finanzberichte verarbeiten. Die Verwendung dieser API gewährleistet, dass bestimmte Texte dauerhaft entfernt werden, wodurch die Sicherheit erhöht und die Einhaltung der Datenschutzstandards sichergestellt wird.

Hinweis:Sobald ein Text geschwärzt ist, kann der Inhalt nicht wiederhergestellt werden.@@--KLAMMER-SCHLIESSEN--@@

Stolzieren

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

Schritte zum Schwärzen von Text mit Swagger

  1. Zugriff auf die Swagger-UI:

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

Swagger-Dokumentation

  1. Den [POST] Redact Text API finden:

    Suchen Sie innerhalb der Swagger-UI den [POST] /v1/document-services/pdfs/redact-text Endpunkt.

! Text schwärzen

  1. Konfigurationen festlegen:

In diesem Beispiel stelle ich sowohl die PDF-Datei als auch die Wörter, die geschwärzt werden sollen, in der POST-Anfrage bereit. Wir werden das Wort "wir" schwärzen und ein schwarzes Kästchen darüberlegen. Für diese Demonstration verwenden wir die Datei " sample.pdf " mit folgenden Konfigurationen:

  • draw_black_box : true
  • vollständiges Wort : true
  • Wörter_zu_redaktieren : wir

  1. Laden Sie eine PDF-Beispieldatei hoch:

    Laden Sie im Anfragetext eine PDF-Beispieldatei hoch, in der Sie die Schwärzung anwenden möchten. Stellen Sie sicher, dass die Datei als PDF-Datei hinzugefügt wird.

  2. Führe die Anfrage aus:

    Klicken Sie auf "Ausführen", um die Anfrage zu starten. Die Antwort enthält die geschwärzte PDF-Datei. Diese Swagger UI-Interaktion ermöglicht es Ihnen, den Schwärzungsprozess einfach zu testen und liefert sofortiges Feedback.

Verwenden Sie eine CURL-Anfrage über die Eingabeaufforderung.

Alternativ können wir die Eingabeaufforderung mit einer curl POST-Anfrage verwenden, um das gleiche Ergebnis zu erzielen.

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
 -H 'accept: */*' \
 -H 'Content-Type: multipart/form-data' \
 -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
 -F 'Wörter_zu_redaktieren="we"' \
 -F 'draw_black_box=true' \
 -F 'vollständiges Wort=true'
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
 -H 'accept: */*' \
 -H 'Content-Type: multipart/form-data' \
 -F 'PDF-Datei=@sample.pdf;type=application/pdf' \
 -F 'Wörter_zu_redaktieren="we"' \
 -F 'draw_black_box=true' \
 -F 'vollständiges Wort=true'
SHELL

[{i:( Standardmäßig interpretiert PowerShell curl möglicherweise als Alias für Invoke-WebRequest , ein integriertes PowerShell-Cmdlet. Versuchen Sie curl.exe anstelle von curl zu verwenden.

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

@@--KLAMMER-SCHLIESSEN--@@

Erforderliche Parameter im Anfragetext

Name Datentyp Beschreibung
PDF-Datei application/pdf Die PDF-Datei, die Sie bearbeiten möchten.
Wörter_zu_redaktieren Array[Zeichenkette] Dieser Parameter nimmt eine Liste von Wörtern entgegen und entfernt den Text, der mit der Eingabe übereinstimmt.

Optionale Anfragekörperparameter

Name Datentyp Beschreibung
Benutzerpasswort zeichenfolge Dies ist erforderlich, wenn die Eingabe-PDF-Datei ein Benutzerpasswort enthält. Der Vorgang schlägt fehl, wenn für die passwortgeschützte PDF-Datei kein Passwort angegeben wird.
Besitzerpasswort zeichenfolge Dies ist erforderlich, wenn die Eingabe-PDF-Datei ein Besitzerpasswort besitzt. Der Vorgang schlägt fehl, wenn für die passwortgeschützte PDF-Datei kein Passwort angegeben wird.
spezifische_Seiten array[int] Hiermit können Sie festlegen, auf welchen Seiten Text geschwärzt werden soll. Standardmäßig ist der Wert null, was bedeutet, dass das angegebene Wort auf allen Seiten geschwärzt wird.
draw_black_box boolescher Wert Hiermit können Sie festlegen, ob der geschwärzte Text mit einem schwarzen Rahmen überdeckt werden soll. Standardmäßig ist dieser Wert auf "Wahr" gesetzt.
vollständiges Wort boolescher Wert Legt fest, ob auch Teilübereinstimmungen innerhalb von Wörtern entfernt werden sollen. Wenn das angegebene Wort beispielsweise "are" lautet, wird das "are" in allen Wörtern, die "are" enthalten, wie etwa "hare", ebenfalls entfernt. Standardmäßig ist diese Option aktiviert.
Fallübereinstimmung boolescher Wert Gibt an, ob das angegebene Wort hinsichtlich Groß- und Kleinschreibung exakt übereinstimmen soll. Standardmäßig ist dieser Wert null. Hinweis: Wenn Sie diese Option auf "True" setzen, werden Zeichenketten nicht zwischen Klein- und Großbuchstaben unterschieden. Wenn das angegebene Wort beispielsweise "WE" lautet, wird die Kleinschreibung "we" nicht entfernt.
überlagernder Text zeichenfolge Es legt den Überlagerungstext fest, beispielsweise Wörter oder Symbole, der über dem geschwärzten Text angezeigt werden soll. Standardmäßig ist diese Zeichenkette leer.
save_as_pdfa boolescher Wert Speichert die geänderte PDF-Datei im PDF/A-3-Format. Standardmäßig ist diese Option deaktiviert.
save_as_pdfua boolescher Wert Speichert die geänderte PDF-Datei mit PDF/UA-Konformität. Standardmäßig ist diese Option deaktiviert.

Optionale Header-Parameter

Name Datentyp Beschreibung
Autor zeichenfolge Dieses Feld dient dazu, Sie als Autor des PDF-Dokuments zu identifizieren. Standardmäßig ist dieses Feld leer.
Titel zeichenfolge Zeigt den Titel des PDF-Dokuments an. Standardmäßig ist dieses Feld leer.
Thema zeichenfolge Hilfreich, um den Inhalt des PDF-Dokuments auf einen Blick zu erfassen. Standardmäßig ist dieses Feld leer.

Häufig gestellte Fragen

Wie kann ich Text in einem PDF mit einer POST-Anfrage schwärzen?

Sie können Text in einer PDF schwärzen, indem Sie eine POST-Anfrage an den IronSecureDoc-Server mit der PDF-Datei und den Wörtern, die Sie schwärzen möchten, senden. Der Server verarbeitet die Anfrage und gibt eine PDF mit geschwärztem Text zurück.

Welche Schritte sind erforderlich, um die IronSecureDoc-API für die Schwärzung von PDFs zu nutzen?

Um die IronSecureDoc-API für die Schwärzung von PDFs zu nutzen, sollten Sie zunächst das IronSecureDoc Docker-Image ziehen und starten, die API mit Swagger testen, den zu schwärzenden Text angeben, den API-Aufruf ausführen und schließlich das geschwärzte PDF-Dokument exportieren.

Wie kann ich die IronSecureDoc-API vor der Nutzung in der Produktion testen?

Sie können die IronSecureDoc-API mithilfe von Swagger testen, indem Sie auf die Swagger UI zugreifen, die Ihnen ermöglicht, die bereitgestellten Endpunkte zu verwenden, um den Schwärzungsprozess zu simulieren.

Welche Parameter können in einer PDF-Schwärzungsanfrage angepasst werden?

In einer PDF-Schwärzungsanfrage können Parameter wie user_password, owner_password, specific_pages, draw_black_box, match_whole_word, match_case, overlay_text, save_as_pdfa und save_as_pdfua für weitere Anpassungen angepasst werden.

Wie führe ich eine PDF-Schwärzungsanfrage mit curl aus?

Um eine PDF-Schwärzungsanfrage mit curl auszuführen, können Sie einen curl POST-Anfragebefehl verwenden, bei dem Sie die erforderlichen Parameter und den Dateipfad in Ihrer Eingabeaufforderung angeben.

Was soll ich tun, wenn mein PDF während der Schwärzung passwortgeschützt ist?

Wenn Ihr PDF passwortgeschützt ist, müssen Sie das Benutzerpasswort oder Eigentümerpasswort in den optionalen Parametern angeben, um sicherzustellen, dass der Schwärzungsprozess auf das Dokument zugreifen und es ändern kann.

Was ist der Zweck des 'draw_black_box'-Parameters bei der Textschwärzung?

Der 'draw_black_box'-Parameter gibt an, ob der geschwärzte Text mit einem schwarzen Kasten überdeckt werden soll. Diese Option ist nützlich zur Visualisierung der geschwärzten Bereiche und ist standardmäßig aktiviert.

Wie kann ich IronSecureDoc lokal für Schwärzungszwecke hosten?

Sie können IronSecureDoc lokal hosten, indem Sie den Tutorials für verschiedene Betriebssysteme wie Windows, Mac oder Linux folgen, sodass Sie den Schwärzungsprozess auf Ihrem lokalen Server verwalten können.

Ist es möglich, bestimmte Seiten in einem PDF zu schwärzen?

Ja, Sie können angeben, welche Seiten geschwärzt werden sollen, indem Sie den 'specific_pages'-Parameter verwenden, der es Ihnen ermöglicht, bestimmte Bereiche des Dokuments für die Schwärzung zu selektieren.

Kann ich Text in einem PDF auf geschwärzten Bereichen überlagern?

Ja, Sie können Text auf geschwärzten Bereichen überlagern, indem Sie den 'overlay_text'-Parameter verwenden, der es Ihnen erlaubt, den geschwärzten Text durch eine benutzerdefinierte Nachricht oder einen Platzhalter zu ersetzen.

Ist IronSecureDoc mit .NET 10 und seinen Clientbibliotheken kompatibel?

Ja, IronSecureDoc bietet einen .NET-Client über das NuGet-Paket Iron Software.SecureDoc.Client an und ist neben früheren Versionen wie .NET 6–9 auch mit .NET 10 kompatibel. Dadurch lässt sich die Schwärzungsfunktion und zugehörige APIs nahtlos in .NET 10-Anwendungen integrieren.

Curtis Chau
Curtis Chau
  Jetzt mit dem Ingenieurteam chatten
Technischer Autor

Curtis Chau hat einen Bachelor-Abschluss in Informatik von der Carleton University und ist spezialisiert auf Frontend-Entwicklung mit Expertise in Node.js, TypeScript, JavaScript und React. Leidenschaftlich widmet er sich der Erstellung intuitiver und ästhetisch ansprechender Benutzerschnittstellen und arbeitet gerne mit modernen Frameworks sowie der Erstellung gut strukturierter, optisch ansprechender ...

Weiterlesen
Bereit anzufangen?
Version: 2024.10 gerade veröffentlicht