1. IronSecureDoc
  2. チュートリアル
  3. IronSecureDoc 用 REST API

C# での IronSecureDoc 用 REST API

カーティス・チャウ
カーティス・チャウ
更新日:
This article was translated from English: Does it need improvement?
Translated
View the article in English

これは、IronSecureDoc インスタンスの REST API リファレンスです。 このチュートリアルでは、コンテナ インスタンスがすでに実行されていることを前提としています。 始めるには、ガイドに従ってください。

機能へジャンプ:

-ライセンスキーを確認する

ブラケット-t-OPEN--@@@。

  • すべての例の URL には、プレースホルダーhttp://localhost:8080/が使用されます。 必ず自分のURLに置き換えてください。
  • プレースホルダーの値 (例: path/to/your/file.pdf 、 certificate_passwordなど) を実際の値に置き換えてください。
  • すべてのリクエスト例には、 author 、 title 、 subjectヘッダーが含まれます。
    ブラケットを閉じる

[GET] ヘルスチェック

エンドポイント: http://localhost:8080/v1/document-services/ping

サーバーが実行中であることを確認するためのヘルス チェック エンドポイント。

応答: 200 OK: pong

[GET] ライセンスの確認

エンドポイント: http://localhost:8080/v1/document-services/check-license

ライセンスの有効性を確認します。

レスポンス: 200 OK: Valid

[投稿] テキストを編集

エンドポイント: http://localhost:8080/v1/document-services/pdfs/redact-text

真の編集機能を使用して、PDF 形式のドキュメント内の機密単語を非表示にします。 リクエスト本文に PDF ファイルをpdf_fileオブジェクトとして含めます。

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

名前データ型翻訳内容
`pdf_file`アプリケーション/PDFファイル編集する PDF ファイル。
`words_to_redact`配列[文字列]文書から削除される単語の配列。
。

よくある質問

IronSecureDoc REST API の目的は何ですか？

IronSecureDoc REST API は、開発者が PDF ドキュメントを保護および管理するのを支援するために設計されており、テキストの編集、デジタル署名の適用、ドキュメントの暗号化、パスワードの検証などの機能を提供します。

IronSecureDoc API を使用して私のサーバーが動作していることをどのように確認できますか？

`/v1/document-services/ping` エンドポイントに GET リクエストを送信することで、サーバーが動作していることを確認できます。成功すれば、サーバーは`200 OK`ステータスとメッセージ`pong`で応答します。

API を使用して PDF 内の特定のテキストやパターンをどのように編集しますか？

`/v1/document-services/pdfs/redact-text` エンドポイントに、編集する PDF とテキストまたは正規表現を含む POST リクエストを送信することで、特定のテキストやパターンを編集できます。

PDF のデジタル署名が有効であるかどうかをどのように確認できますか？

PDF 内のデジタル署名を確認するには、`/v1/document-services/pdfs/verify-signatures` エンドポイントに PDF ファイルを含む POST リクエストを送信します。API は各署名の有効性に関する情報を返します。

IronSecureDoc API を使用して PDF を暗号化するにはどのような手順が必要ですか？

PDF を暗号化するには、ユーザーおよび所有者のパスワードを指定し、ページ内容の抽出やフォームの記入などの設定したい権限を含めて、PDF ファイルを `/v1/document-services/pdfs/encrypt` エンドポイントに POST リクエストとして送信します。

IronSecureDoc API を使用して PDF ドキュメントにデジタル署名する方法は？

PDF にデジタル署名を行うには、PDF ファイル、デジタル証明書、および証明書のパスワードを含む POST リクエストを `/v1/document-services/pdfs/certify` エンドポイントに送信します。

PDF ドキュメントを保護するためのオプションはどれですか？

PDF を保護するためのオプションには、ドキュメントの暗号化、アクセス権の設定、ユーザーおよび所有者のパスワードの追加、IronSecureDoc API を使用した既存のパスワードの確認が含まれます。

IronSecureDoc API を使用して PDF からテキストを抽出することは可能ですか？

はい、`/v1/document-services/pdfs/extract` エンドポイントに POST リクエストを送信することで PDF からテキストを抽出できます。特定のページまたはドキュメント全体からテキストを抽出するパラメーターを指定できます。

PDF ドキュメントのパスワードをどのように確認しますか？

パスワードを確認するには、ユーザーおよび所有者のパスワードを含む PDF ファイルを使った POST リクエストを `/v1/document-services/pdfs/verify-password` エンドポイントに送信します。これにより、それらの有効性が確認されます。

IronSecureDoc REST API の主要機能は何ですか？

IronSecureDoc REST API の主要機能には、サーバーの健全性チェック、ライセンス検証、テキストの赤字化、デジタル署名の適用、PDF の暗号化、テキストの抽出が含まれます。

カーティス・チャウ
カーティス・チャウ
  今すぐエンジニアリングチームとチャット
テクニカルライター

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

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

準備はできましたか？
Version: 2024.10 リリース