C#でのIronSecureDoc用REST API
これは、IronSecureDoc インスタンスの REST API リファレンスです。 このチュートリアルでは、コンテナ インスタンスがすでに実行されていることを前提としています。 もし開始をお望みなら、ガイドに従ってください。
機能へジャンプ:
- ライセンスキーを確認
- PDF墨消し機能
- PDF署名機能
- PDF保護機能
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
[POST] テキストを墨消し
エンドポイント: http://localhost:8080/v1/document-services/pdfs/redact-text
実際にデータを削除する墨消し処理により、PDF文書内の機密性の高い単語を非表示にします。リクエストボディにpdf_fileオブジェクトとしてPDFファイルを含めてください。
必須のリクエストボディパラメータ
よくある質問
IronSecureDocのREST APIの目的は何ですか?
IronSecureDocのREST APIは、ドキュメントの秘匿処理、署名、保護、検証などの操作を行うエンドポイントを提供することで、開発者がドキュメントを安全に管理できるようにします。
IronSecureDoc REST APIサーバーが動作しているかどうかを確認するにはどうすればよいですか?
IronSecureDoc REST APIサーバーが動作しているかを確認するには、'GET' Health Checkエンドポイントを'http://localhost:8080/v1/document-services/ping'で使用してください。成功した応答には'pong'が返されます。
REST APIを使用してIronSecureDocライセンスの有効性を確認するにはどうすればよいですか?
'GET' Check Licenseエンドポイントを'http://localhost:8080/v1/document-services/check-license'で使用することで、IronSecureDocライセンスの有効性を確認できます。成功したライセンスチェックでは'Valid'が返されます。
IronSecureDocのREST APIを使用してPDFのテキストを秘匿処理するには何が必要ですか?
IronSecureDocのREST APIを使用してPDFのテキストを秘匿処理するには、application/pdf形式の'pdf_file'と'words_to_redact'の配列をパラメータとしてPOSTリクエストの'http://localhost:8080/v1/document-services/pdfs/redact-text'エンドポイントに提供します。
IronSecureDocを使用してPDFにデジタル署名を適用できますか?
はい、IronSecureDocを使用すると、REST APIエンドポイントを通じて利用可能な'Certify PDF / Apply Digital Signature'機能を使用してPDFにデジタル署名を適用できます。
IronSecureDocのAPIを通じてPDFにパスワードで保護するにはどうすればよいですか?
IronSecureDocのREST APIを通じて'Encrypt / Add Password to PDF'機能を使用してPDFを暗号化またはパスワードを追加することで保護できます。
IronSecureDocのAPIを使用してPDF上の署名を検証することは可能ですか?
はい、IronSecureDocは、REST APIの'Verify Certificates / Signatures'エンドポイントを通じてPDF上の証明書と署名を検証する機能を提供します。
IronSecureDocのREST APIを使用するメリットは何ですか?
IronSecureDocのREST APIを使用することで、ドキュメントの秘匿処理、署名、暗号化、およびプログラムによる検証などのドキュメント管理プロセスを自動化し、アプリケーションに簡単に統合できます。
IronSecureDocを使用してPDFの権限を変更できますか?
はい、IronSecureDocのREST APIは、PDFの保護機能の一部としてPDFの権限を設定および変更することを可能にします。
IronSecureDocのチュートリアルでプレースホルダーURLに関する問題が発生した場合、どうすればよいですか?
IronSecureDocのチュートリアルでプレースホルダーURLに関する問題が発生した場合は、'http://localhost:8080/'を実際のサーバURLに置き換え、リクエストURLの例値を適切なデータに置き換えてください。
Curtis Chauは、カールトン大学でコンピュータサイエンスの学士号を取得し、Node.js、TypeScript、JavaScript、およびReactに精通したフロントエンド開発を専門としています。直感的で美しいユーザーインターフェースを作成することに情熱を持ち、Curtisは現代のフレームワークを用いた開発や、構造の良い視覚的に魅力的なマニュアルの作成を楽しんでいます。