How to Redact Text in C# PDF with IronSecureDoc

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

W tym artykule omówimy redagowanie tekstu w PDF-ie za pomocą IronSecureDoc. To umożliwia usłudze lub procesowi szybkie i łatwe redagowanie poufnych informacji przez prosty POST request z PDF-em do działającego serwera IronSecureDoc. Pokażemy to wizualnie poprzez użycie dokumentacji Swagger. Żądanie POST przyjmuje zarówno obowiązkowe, jak i opcjonalne parametry i jest wysoce konfigurowalne; odpowiedź zwraca PDF z zredagowanym tekstem.

Pobierz i uruchom IronSecureDoc

Jeśli jeszcze nie uruchomiłeś IronSecureDoc, skorzystaj z poniższych linków, aby go skonfigurować:

Hostuj lokalnie Wdrożenie w chmurze

API [POST] Redaction Tekstu

Punkt końcowy API [POST] Redaction Tekstu pozwala na ukrywanie poufnego tekstu w dokumencie PDF poprzez redagowanie. Ta funkcjonalność jest niezbędna dla aplikacji obsługujących poufne dokumenty, takie jak umowy prawne, dokumentacja medyczna czy raporty finansowe. Korzystając z tego API, zapewniamy, że określony tekst jest trwale usunięty, co zwiększa bezpieczeństwo i zapewnia zgodność ze standardami ochrony danych.

Zwróć uwagęGdy tekst zostanie zredagowany, treść nie może być odzyskana.

Swagger

Swagger to potężne narzędzie, które umożliwia deweloperom interakcję z RESTful API poprzez przyjazny interfejs internetowy. Niezależnie od tego, czy używasz języków takich jak Python, Java czy innych, Swagger oferuje wygodny sposób testowania i wdrażania tego API.

Kroki do zaciemniania tekstu za pomocą Swagger

  1. Uzyskaj dostęp do Swagger UI:

Jeśli twój serwer API działa lokalnie, możesz uzyskać dostęp do Swagger, nawigując do http://localhost:8080/swagger/index.html w przeglądarce internetowej.

Dokumentacja Swagger

  1. Zlokalizuj API [POST] Redaction Tekstu:

W interfejsie Swagger znajdź punkt końcowy [POST] /v1/document-services/pdfs/redact-text.

Redagowanie tekstu

  1. Określ Konfiguracje:

W tym przykładzie dostarczam zarówno plik PDF, jak i słowa do redagowania w zapytaniu POST. Zredagujemy słowo "we" i nałożymy na nie czarną ramkę. Do tej demonstracji użyjemy pliku 'sample.pdf' z następującymi konfiguracjami:

  • draw_black_box: true
  • match_whole_word: true
  • words_to_redact: we
  1. Prześlij przykładowy PDF:

    W ciele żądania, prześlij przykładowy plik PDF, gdzie chcesz zastosować zaciemnienie. Ensure that the file is added as pdf_file.

  2. Uruchom żądanie:

Kliknij "Wykonaj", aby uruchomić zapytanie. Odpowiedź będzie zawierać zredagowany PDF. Interakcja z Swagger UI umożliwia łatwe przetestowanie procesu redagowania, dostarczając natychmiastową informację zwrotną.


Użyj zapytania CURL przez wiersz poleceń

Alternatywnie możemy użyć wiersza poleceń z curl POST request, aby osiągnąć ten sam efekt.

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'
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'
SHELL

Zwróć uwagę
Domyślnie PowerShell może interpretować curl jako alias dla Invoke-WebRequest, wbudowanego polecenia PowerShell cmdlet. Spróbuj użyć curl.exe zamiast curl.

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

)}]

Obowiązkowe Parametry Treści Żądania

Imię Typ danych Opis
pdf_file application/pdf Plik PDF, który chcesz zmodyfikować.
words_to_redact array[ciąg znaków] Ten parametr przyjmuje listę słów i redaguje tekst zgodny z wprowadzonymi danymi.

Opcjonalne Parametry Treści Żądania

Imię Typ danych Opis
user_password ciąg znaków Jest to wymagane, jeśli wejściowy PDF ma hasło użytkownika. Operacja zakończy się niepowodzeniem, jeśli nie zostanie podane hasło do pliku PDF zabezpieczonego hasłem.
owner_password ciąg znaków Jest to wymagane, jeśli wejściowy PDF ma hasło właściciela. Operacja zakończy się niepowodzeniem, jeśli nie zostanie podane hasło do pliku PDF zabezpieczonego hasłem.
specific_pages array[int] Pozwala określić, które strony mają zostać zredagowane. Domyślnie wartość jest pusta, co oznacza, że podane słowo na wszystkich stronach zostanie zredagowane.
draw_black_box boolean Pozwala określić, czy narysować czarną ramkę nad zredagowanym tekstem. Domyślnie ta wartość jest ustawiona na True.
match_whole_word boolean Określa, czy częściowe dopasowania w ramach słów również powinny być zredagowane. Na przykład, jeśli podane słowo to "are," każde słowo zawierające "are," takie jak "hare," będzie miało "are" zredagowane. Domyślnie ta wartość jest ustawiona na True.
match_case boolean Określa, czy podane słowo powinno być dokładne pod względem wielkości liter. Domyślnie ta wartość jest pusta. Uwaga: Ustawienie tej wartości na True oznacza, że ciągi małymi i wielkimi literami nie będą dopasowane. Na przykład, jeśli podane słowo to "WE", wersja "we" małymi literami nie będzie zredagowana.
overlay_text ciąg znaków Określa tekst nakładki, taki jak słowa lub symbole, nad zredagowanym tekstem. Domyślnie ten ciąg jest pusty.
save_as_pdfa boolean Zapisuje zmodyfikowany PDF ze zgodnością z PDF/A-3. Domyślnie ta wartość jest ustawiona na False.
save_as_pdfua boolean Zapisuje zmodyfikowany PDF ze zgodnością z PDF/UA. Domyślnie ta wartość jest ustawiona na False.

Opcjonalne Parametry Nagłówka

Imię Typ danych Opis
author ciąg znaków Przydatne do identyfikacji Ciebie jako autora dokumentu PDF. Domyślnie to pole jest puste.
title ciąg znaków Wyświetla tytuł dokumentu PDF. Domyślnie to pole jest puste.
subject ciąg znaków Przydatne do szybkiej identyfikacji zawartości dokumentu PDF. Domyślnie to pole jest puste.

Często Zadawane Pytania

Jak mogę zredagować tekst w PDF za pomocą żądania POST?

Możesz zredagować tekst w PDF, wysyłając żądanie POST do serwera IronSecureDoc z plikiem PDF i słowami, które chcesz zredagować. Serwer przetwarza żądanie i zwraca PDF ze zredagowanym tekstem.

Jakie są kroki używania API IronSecureDoc do redagowania PDF?

Aby używać API IronSecureDoc do redagowania PDF, najpierw należy pobrać i uruchomić obraz Docker IronSecureDoc, przetestować API za pomocą Swagger, określić tekst do redagowania, wykonać wywołanie API, a na końcu wyeksportować zredagowany dokument PDF.

Jak mogę przetestować API IronSecureDoc przed użyciem go w produkcji?

Możesz przetestować API IronSecureDoc przy użyciu Swagger, uzyskując dostęp do Swagger UI, co pozwala na użycie dostarczonych punktów końcowych do symulacji procesu redagowania.

Jakie parametry można dostosować w żądaniu redagowania PDF?

W żądaniu redagowania PDF można dostosować parametry takie jak user_password, owner_password, specific_pages, draw_black_box, match_whole_word, match_case, overlay_text, save_as_pdfa i save_as_pdfua, aby uzyskać dalsze dostosowania.

Jak wykonać żądanie redagowania PDF za pomocą curl?

Aby wykonać żądanie redagowania PDF za pomocą curl, możesz użyć polecenia curl POST, określając niezbędne parametry i ścieżkę pliku w wierszu poleceń.

Co powinnam zrobić, jeśli mój PDF jest zabezpieczony hasłem podczas redagowania?

Jeśli twój PDF jest zabezpieczony hasłem, musisz uwzględnić user_password lub owner_password w opcjonalnych parametrach, aby upewnić się, że proces redagowania może uzyskać dostęp do dokumentu i go zmodyfikować.

Jaki jest cel parametru 'draw_black_box' w redagowaniu tekstu?

Parametr 'draw_black_box' określa, czy zakrywać zredagowany tekst czarnym boksem. Ta opcja jest użyteczna do wizualizacji zredagowanych obszarów i jest domyślnie włączona.

Jak mogę lokalnie hostować IronSecureDoc do celów redagowania?

Możesz lokalnie hostować IronSecureDoc, postępując zgodnie z samouczkami dostarczonymi dla różnych systemów operacyjnych, takich jak Windows, Mac lub Linux, co pozwala na zarządzanie procesem redagowania na lokalnym serwerze.

Czy jest możliwe zredagowanie określonych stron w PDF?

Tak, możesz określić, które strony redagować, używając parametru 'specific_pages', który pozwala na ukierunkowanie redagowania na konkretne obszary dokumentu.

Czy mogę nałożyć tekst na zredagowane obszary w PDF?

Tak, możesz nałożyć tekst na zredagowane obszary, używając parametru 'overlay_text', który pozwala zastąpić zredagowany tekst niestandardową wiadomością lub zastępczym tekstem.

Czy IronSecureDoc jest kompatybilny z .NET 10 i jego bibliotekami klienckimi?

Tak, IronSecureDoc zapewnia klienta .NET za pośrednictwem pakietu NuGet IronSoftware.SecureDoc.Client i jest kompatybilny z .NET 10 oraz poprzednimi wersjami, takimi jak .NET 6–9. To zapewnia możliwość bezproblemowej integracji redagowania i powiązanych API w aplikacjach .NET 10.

Curtis Chau
Autor tekstów technicznych

Curtis Chau posiada tytuł licencjata z informatyki (Uniwersytet Carleton) i specjalizuje się w front-endowym rozwoju, z ekspertką w Node.js, TypeScript, JavaScript i React. Pasjonuje się tworzeniem intuicyjnych i estetycznie przyjemnych interfejsów użytkownika, Curtis cieszy się pracą z nowoczesnymi frameworkami i tworzeniem dobrze zorganizowanych, atrakcyjnych wizualnie podrę...

Czytaj więcej
Gotowy, aby rozpocząć?
Wersja: 2024.10 just released
Still Scrolling Icon

Wciąż przewijasz?

Czy chcesz szybko dowodu?
uruchom przykład zobacz, jak twój PDF staje się zaszyfrowany.