So schwärzen Sie Text in PDF mit IronSecureDoc
In diesem Artikel werden wir besprechen, wie man Text in einem PDF mit IronSecureDoc redigiert. Dies ermöglicht es dem Dienst oder Prozess, sensible Informationen schnell und einfach zu schwärzen, indem eine einfache POST-Anfrage mit dem PDF an den laufenden IronSecureDoc-Server gesendet wird. Wir werden dies visuell anhand der Nutzung von Swagger-Dokumenten demonstrieren. Die POST-Anfrage nimmt sowohl erforderliche als auch optionale Parameter auf und ist hochgradig anpassbar; Die Antwort liefert das PDF mit dem geschwärzten Text zurück.
So schwärzen Sie Text in PDF mit IronSecureDoc
- Ziehen und starten Sie das IronSecureDoc Docker Image
- Testen Sie die API mit Swagger
- Geben Sie den zu redigierenden Text an
- Führen Sie den API-Aufruf mit den bereitgestellten Details aus.
- Exportieren Sie das geschwärzte PDF-Dokument
Ziehen und Starten von IronSecureDoc
Wenn Sie IronSecureDoc noch nicht gestartet haben, folgen Sie bitte den unten stehenden Links, um es einzurichten:
| Lokal hosten | In die Cloud bereitstellen |
|---|---|
Die [POST] Redact Text API
Der [POST] Redact Text-API-Endpunkt ermöglicht es Ihnen, sensiblen Text in einem PDF-Dokument durch Schwärzung zu verbergen. Diese Funktionalität ist essenziell für Anwendungen, die mit vertraulichen Dokumenten umgehen, wie beispielsweise juristischen Verträgen, medizinischen Unterlagen oder Finanzberichten. Durch die Verwendung dieser API können Sie sicherstellen, dass bestimmter Text dauerhaft entfernt wird, was eine verbesserte Sicherheit bietet und die Einhaltung von Datenschutzstandards gewährleistet.
Bitte beachten Sie
Swagger
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 von Text mit Swagger
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.
Finden Sie die [POST] Redact Text API:
Im Swagger UI finden Sie den [POST] /v1/document-services/pdfs/redact-text Endpunkt.
Konfigurationen festlegen:
In diesem Beispiel stelle ich sowohl die PDF-Datei als auch die zu schwärzenden Wörter in der POST-Anfrage bereit. Wir werden das Wort "wir" schwärzen und ein schwarzes Kästchen darüber legen. Für diese Demonstration verwenden wir die Datei 'sample.pdf' mit den folgenden Konfigurationen:
- draw_black_box: true
- match_whole_word: true
- words_to_redact: wir
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.
Die Anforderung ausführen:
Klicken Sie auf "Ausführen", um die Anfrage auszuführen. Die Antwort wird das geschwärzte PDF enthalten. Diese Swagger-UI-Interaktion ermöglicht es Ihnen, den Schwärzungsprozess einfach zu testen und bietet sofortiges Feedback.
Das Ergebnis verstehen
Wir führen die POST-Anfrage aus, nachdem wir die erforderlichen Parameter im Swagger-Dokument eingegeben haben. Bei Erfolg gibt die Anfrage einen 200-Statuscode mit einer bearbeiteten PDF-Datei zurück, die wie im obigen Beispiel heruntergeladen werden kann.
Die oben geänderte PDF-Datei zeigt Bereiche, in denen das Wort „wir“ erscheint und durch ein schwarzes Kästchen ersetzt wird. Außerdem ist der boolesche Wert match_whole_word auf True gesetzt, was darauf hinweist, dass wir nur ganze Wörter und keine Teilübereinstimmungen innerhalb von Wörtern schwärzen.
-->
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_file=@sample.pdf;type=application/pdf' \
-F 'words_to_redact="we"' \
-F 'draw_black_box=true' \
-F 'match_whole_word=true'Bitte beachten Sie
curl.exe --versionErforderliche Parameter des Anfragekörpers
Optionale Parameter des Anfragekörpers
| Name | Data Type | Description |
|---|---|---|
| user_password | string | This is required if the input PDF has a user password. The operation will fail if no password is provided for the password-protected PDF. |
| owner_password | string | This is required if the input PDF has an owner password. The operation will fail if no password is provided for the password-protected PDF. |
| specific_pages | array[int] | Allows you to specify which pages to redact text on. By default, the value is null, meaning the provided word in all the pages will be redacted. |
| draw_black_box | boolean | Allows you to specify whether to draw a black box over the redacted text. By default, this value is set to True. |
| match_whole_word | boolean | Specifies whether partial matches within words should also be redacted. For example, if the provided word is "are," any words containing "are," such as "hare," will have the "are" redacted as well. By default, this is set to True. |
| match_case | boolean | Specifies whether the provided word should be an exact match in terms of case. By default, this value is null. Note: Setting this to True means that lowercase and uppercase strings will not be matched. For example, if the provided word is "WE," the lowercase version "we" would not be redacted. |
| overlay_text | string | It specifies the overlay text, such as words or symbols, over the redacted text. By default, this string is empty. |
| save_as_pdfa | boolean | Saves the modified PDF with PDF/A-3 compliance. By default, this is set to False. |
| save_as_pdfua | boolean | Saves the modified PDF with PDF/UA compliance. By default, this is set to False. |
Optionale Header-Parameter
| Name | Data Type | Description |
|---|---|---|
| author | string | Useful for identifying you as the author of the PDF document. By default, this field is empty. |
| title | string | Displays the title of the PDF document. By default, this field is empty. |
| subject | string | Useful for identifying the content of the PDF document at a glance. By default, this field is empty. |
