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

この記事では、IronSecureDoc を使用して PDF 上のテキストを編集する方法について説明します。 これにより、稼働中の IronSecureDoc サーバーに対して PDF ファイルと共に簡単な POST リクエストを送信するだけで、サービスまたはプロセスが機密情報を迅速かつ容易に黒塗り処理できるようになります。 Swagger ドキュメントを使用してこれを視覚的に実証します。 POSTリクエストは、必須パラメータとオプションパラメータの両方を受け付け、高度にカスタマイズ可能です; 応答では、編集されたテキストを含む PDF が返されます。

IronSecureDoc をプルして起動する

IronSecureDoc をまだ実行していない場合は、以下のリンクに従ってセットアップしてください。

ローカルでホストクラウドへのデプロイ

[POST] テキスト編集 API

[POST] Redact Text API エンドポイントを使用すると、編集機能を使用して PDF ドキュメント内の機密テキストを非表示にすることができます。 この機能は、法的契約、医療記録、財務報告書などの機密文書を扱うアプリケーションにとって不可欠です。 この API を使用すると、特定のテキストが完全に削除され、セキュリティが強化され、データ保護標準への準拠が保証されます。

ご注意テキストが修正されると、コンテンツは復元できません。

威勢のいい

Swagger は、開発者がユーザーフレンドリーな Web インターフェースを通じて RESTful API と対話できるようにする強力なツールです。 Python、Java などの言語を使用している場合でも、Swagger を使用すると、この API をテストおよび実装する便利な方法が得られます。

威勢のいいでテキストを編集する手順

  1. Swagger UI にアクセスします。

    APIサーバーがローカルで実行されている場合は、Webブラウザで http://localhost:8080/swagger/index.html にアクセスすることでSwaggerを利用できます。

    Swagger ドキュメント

  2. [POST] Redact Text APIを見つけます。

    Swagger UI内で、POST /v1/document-services/pdfs/redact-text エンドポイントを探してください。

    テキストを伏せ字にする

3.構成を指定します。

この例では、PDFファイルと、POSTリクエストで伏せ字にする単語の両方を提供します。"we"という単語を伏せ字にし、その上に黒いボックスを重ねます。 このデモでは、次の構成の" sample.pdf "ファイルを使用します。

  • draw_black_box: true
  • match_whole_word: true
  • words_to_redact: we

4.サンプルPDFをアップロードします。

リクエスト本文で、編集を適用するサンプル PDF ファイルをアップロードします。 ファイルが pdf_file として追加されていることを確認してください。

5.リクエストを実行します。

"実行"をクリックしてリクエストを実行します。レスポンスには編集されたPDFが含まれます。 この Swagger UI インタラクションにより、編集プロセスを簡単にテストし、即時のフィードバックを得ることができます。


コマンドプロンプトからCURLリクエストを使用する

あるいは、コマンドプロンプトで curl POST コマンドを実行することで、同様の結果を得ることができます。

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

[{私:(
デフォルトでは、PowerShell は curl を、組み込みの PowerShell コマンドレットである Invoke-WebRequest のエイリアスとして解釈する場合があります。 curl の代わりに curl.exe を使用してみてください。

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

)}]

必須のリクエストボディパラメータ

名前データ型翻訳内容
pdf_ファイルapplication/pdf操作する PDF ファイル。
words_to_redactarray[string]このパラメータは単語のリストを受け取り、入力に一致するテキストを編集します。

オプションのリクエストボディパラメータ

名前データ型翻訳内容
ユーザーパスワード文字列入力PDFにユーザーパスワードが設定されている場合は必須です。パスワード保護されたPDFにパスワードが指定されていない場合、操作は失敗します。
所有者パスワード文字列入力PDFに所有者パスワードが設定されている場合は必須です。パスワード保護されたPDFにパスワードが指定されていない場合、操作は失敗します。
特定のページarray[int]テキストを編集するページを指定できます。デフォルトではnullの値が設定されており、提供された単語がすべてのページで編集されます。
draw_black_boxboolean編集したテキストに黒いボックスを描画するかどうかを指定できます。デフォルトでは、この値はTrueに設定されています。
match_whole_wordboolean単語内の部分一致も編集するかどうかを指定します。例えば、提供された単語が"are"の場合、"hare"を含む単語も"are"が編集されます。デフォルトではTrueに設定されています。
match_caseboolean提供された単語が大文字小文字を含む正確な一致であるかどうかを指定します。デフォルトでは、この値はnullです。注記: これをTrueに設定すると、小文字と大文字の文字列は一致しません。例えば、提供された単語が"WE"の場合、小文字の"we"は編集されません。
overlay_text文字列編集されたテキストの上に重ねるオーバーレイテキスト(単語や記号など)を指定します。デフォルトでは、この文字列は空です。
save_as_pdfabooleanPDFをPDF/A-3準拠で保存します。デフォルトではFalseに設定されています。
save_as_pdfuabooleanPDFをPDF/UA準拠で保存します。デフォルトではFalseに設定されています。

オプションのヘッダーパラメータ

名前データ型翻訳内容
著者文字列PDF文書の作成者を識別するのに役立ちます。デフォルトでは、このフィールドは空です。
タイトル文字列PDFドキュメントのタイトルを表示します。デフォルトでは、このフィールドは空です。
件名文字列PDF文書の内容を一目で確認するのに役立ちます。デフォルトでは、このフィールドは空です。

よくある質問

POSTリクエストを使用してPDF内のテキストを編集するにはどうすればよいですか?

PDFファイルと編集したい単語をIronSecureDocサーバーにPOSTリクエストすることで、PDFのテキストを編集できます。サーバーはリクエストを処理し、編集されたテキストを含むPDFを返します。

IronSecureDoc APIを使ったPDF編集のステップは何ですか?

PDF編集のためにIronSecureDoc APIを使用するには、まずIronSecureDoc Dockerイメージを取得して開始し、Swaggerを使用してAPIをテストし、編集するテキストを指定し、API呼び出しを行い、最終的に編集されたPDFドキュメントをエクスポートする必要があります。

本番使用前にIronSecureDoc APIをテストするにはどうしたらよいですか?

Swagger UIにアクセスしてSwaggerを使ってIronSecureDoc APIをテストできます。提供されたエンドポイントを使って編集プロセスをシミュレートすることができます。

PDF編集リクエストではどのパラメータをカスタマイズできますか?

PDF編集リクエストでは、ユーザーパスワード、オーナーパスワード、特定のページ、ブラックボックスの描画、完全一致、ケースに一致、オーバーレイテキスト、PDF/AやPDF/UAとして保存などのパラメータをカスタマイズできます。

curlを使用してPDF編集リクエストを実行するにはどうすればよいですか?

curlを使用してPDF編集リクエストを実行するには、コマンドプロンプトで必要なパラメータとファイルパスを指定してcurl POSTリクエストコマンドを使用します。

編集中にPDFがパスワードで保護されている場合はどうすればよいですか?

PDFがパスワードで保護されている場合、オプションパラメータにユーザーパスワードまたはオーナーパスワードを含めて、編集プロセスがドキュメントにアクセスして変更できるようにする必要があります。

テキスト編集での'draw_black_box'パラメータの目的は何ですか?

'draw_black_box'パラメータは、編集されたテキストを黒いボックスで覆うかを指定。デフォルトで有効。

編集目的でIronSecureDocをローカルでホストするにはどうすればよいですか?

Windows、Mac、またはLinuxなどのさまざまなオペレーティングシステム向けに提供されているチュートリアルに従うことで、IronSecureDocをローカルでホストし、ローカルサーバーで編集プロセスを管理できます。

PDFの特定のページを編集することはできますか?

はい、特定の領域の編集をターゲットとするための'specific_pages'パラメータを使用して、編集するページを指定することができます。

PDFで編集された領域にテキストをオーバーレイすることはできますか?

はい、カスタムメッセージやプレースホルダーで編集されたテキストを置き換えるために'overlay_text'パラメータを使用して、編集された領域にテキストをオーバーレイすることができます。

IronSecureDoc は .NET 10 およびそのクライアント ライブラリと互換性がありますか?

はい、IronSecureDoc は NuGet パッケージ Iron Software.SecureDoc.Client を介して .NET クライアントを提供しており、.NET 6~9 などの以前のバージョンに加えて .NET 10 とも互換性があります。これにより、.NET 10 アプリケーションに墨消し機能や関連 API をシームレスに統合できます。

カーティス・チャウ
テクニカルライター

Curtis Chauは、カールトン大学でコンピュータサイエンスの学士号を取得し、Node.js、TypeScript、JavaScript、およびReactに精通したフロントエンド開発を専門としています。直感的で美しいユーザーインターフェースを作成することに情熱を持ち、Curtisは現代のフレームワークを用いた開発や、構造の良い視覚的に魅力的なマニュアルの作成を楽しんでいます。

開発以外にも、CurtisはIoT(Internet of Things)への強い関心を持ち、ハードウェアとソフトウェアの統合方法を模索しています。余暇には、ゲームをしたりDiscordボットを作成したりして、技術に対する愛情と創造性を組み合わせています。

準備はできましたか?
バージョン: 2024.10 just released
Still Scrolling Icon

まだスクロールしていますか?

すぐに証拠が欲しいですか?
サンプルを実行する PDF が暗号化されるのを見る。