1. IronSecureDoc
  2. チュートリアル
  3. Azureホストとセットアップ

IronSecureDocのREST API

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

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

ヒント

[ゲット] 健康チェック

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

サーバーが稼動していることを確認するためのヘルスチェックエンドポイント。

レスポンス：200 OK: pong

[ゲット] ライセンスチェック

エンドポイント： 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ファイル アプリケーション/pdfファイル 再編集するPDFファイル。

単語_to_redact 配列[文字列] 文書から削除する単語の配列。

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

名前 データ・タイプ デフォルト 概要

ユーザーパスワード ストリング ヌル 入力PDFのユーザーパスワード。 PDF に読み取 り ア ク セ ス を許可す る ためのユーザーパ ス ワー ド があ る 場合は必須。

オーナーパスワード ストリング ヌル 入力 PDF の所有者パスワード。 PDF が所有者パスワー ド を持っ ていて、 変更を行 う ためのア ク セ ス を与え る 場合は必須。

特定のページ 配列[int] ヌル 任意で適用するページを指定する。 空欄の場合、すべてのページが適用されます。

ドロー・ブラック・ボックス ブール 真 冗長化されたテキストエリアにブラックボックスを引く。

match_whole_word ブール 真 単語内の部分一致も編集できるようにする。

マッチケース ブール ヌル 編集する単語の大文字と小文字を一致させる。

オーバーレイテキスト ストリング ヌル 文字や記号など、再編集領域にオーバーレイテキストを表示したい場合は、ここで設定します。 設定されていない場合は、空白文字が使用される。

セーブ_アズ_pdfa ブール 偽 PDF/A-3に準拠してPDFを保存します。

save_as_pdfua ブール 偽 PDF/UAに準拠してPDFを保存します。

オプションのヘッダー

名前 データ・タイプ 概要**

著者 ストリング PDF Metadata Authorプロパティを設定します。

タイトル ストリング PDFメタデータタイトルプロパティを設定します。

件名 ストリング PDF Metadata Subjectプロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

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="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
CURL

すべての必須およびオプションのパラメータ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

回答：

  • 200 PDFファイルを添付してOK。

[ポスト] 正規表現の変更

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

敏感な正規表現マッチを隠す (日付、名前、パターンなど) 真の再編集を使用したPDF形式の文書。 PDF ファイルを pdf_file オブジェクトとしてリクエストボディに含める。

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

名前 データ・タイプ 概要**

pdfファイル アプリケーション/pdfファイル 再編集するPDFファイル。

正規表現 ストリング マッチしたケースを文書から編集する正規表現。

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

名前 データ・タイプ デフォルト 概要

ユーザーパスワード ストリング ヌル 入力PDFのユーザーパスワード。 PDF に読み取 り ア ク セ ス を許可す る ためのユーザーパ ス ワー ド があ る 場合は必須。

オーナーパスワード ストリング ヌル 入力 PDF の所有者パスワード。 PDF が所有者パスワー ド を持っ ていて、 変更を行 う ためのア ク セ ス を与え る 場合は必須。

特定のページ 配列[int] ヌル 任意で適用するページを指定する。 空欄の場合、すべてのページが適用されます。

ドロー・ブラック・ボックス ブール 真 冗長化されたテキストエリアにブラックボックスを引く。

オーバーレイテキスト ストリング ヌル 文字や記号など、再編集領域にオーバーレイテキストを表示したい場合は、ここで設定します。 設定されていない場合は、空白文字が使用される。

セーブ_アズ_pdfa ブール 偽 PDF/A-3に準拠してPDFを保存します。

save_as_pdfua ブール 偽 PDF/UAに準拠してPDFを保存します。

オプションのヘッダー

名前 データ・タイプ 概要**

著者 ストリング PDF Metadata Authorプロパティを設定します。

タイトル ストリング PDFメタデータタイトルプロパティを設定します。

件名 ストリング PDF Metadata Subjectプロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
CURL

すべての必須およびオプションのパラメータ：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

回答：

  • 200 PDFファイルを添付してOK。

[ポスト] リージョンの再編集

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

説明：真の再編集を使用して PDF 文書の特定の領域に機密テキストを隠します。 PDF ファイルを pdf_file オブジェクトとしてリクエストボディに含める。

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

名前 データ・タイプ 概要**

pdfファイル アプリケーション/pdfファイル 再編集するPDFファイル。

地域_to_redact_x フロート ページの左下から始まる、再編集する領域の X 座標。

地域_to_redact_y フロート ページの左下から始まる、朱書きする領域のY座標。

地域_to_redact_w フロート 指定したX座標から始まる、再編集する領域の幅。

地域_to_redact_h フロート 指定した Y 座標を始点とする、再編集する領域の高さ。

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

名前 データ・タイプ デフォルト 概要

ユーザーパスワード ストリング ヌル 入力PDFのユーザーパスワード。 PDF に読み取 り ア ク セ ス を許可す る ためのユーザーパ ス ワー ド があ る 場合は必須。

オーナーパスワード ストリング ヌル 入力 PDF の所有者パスワード。 PDF が所有者パスワー ド を持っ ていて、 変更を行 う ためのア ク セ ス を与え る 場合は必須。

特定のページ 配列[int] ヌル 任意で適用するページを指定する。 空欄の場合、すべてのページが適用されます。

ドロー・ブラック・ボックス ブール 真 冗長化されたテキストエリアにブラックボックスを引く。

セーブ_アズ_pdfa ブール 偽 PDF/A-3に準拠してPDFを保存します。

save_as_pdfua ブール 偽 PDF/UAに準拠してPDFを保存します。

オプションのヘッダー

名前 データ・タイプ 概要**

著者 ストリング PDF Metadata Authorプロパティを設定します。

タイトル ストリング PDFメタデータタイトルプロパティを設定します。

件名 ストリング PDF Metadata Subjectプロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
CURL

すべての必須およびオプションのパラメータ：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

回答：

  • 200 PDFファイルを添付してOK。

[ポスト] 電子署名の認証/適用

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

もちろん、英語のテキストを教えていただけますでしょうか？

説明：証明書ファイルによって PDF 文書が改ざんされていないことを保証するために、PDF 文書に証明書を追加します。 (.p12, .pfx). PDFファイルを pdf_file オブジェクトとしてリクエストボディに、証明書ファイルを certificate_file オブジェクトとしてリクエストボディに含める。

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

名前 データ・タイプ 概要**

pdfファイル アプリケーション/pdfファイル 証明するPDFファイル。

証明書ファイル application/x-pkcs12 ファイル 証明書ファイル (.p12, .pfx) を認証に使用する。

証明書パスワード ストリング 提供された証明書ファイルのパスワード。

サーティフィケート・パーミッション イント 認証の許可タイプ：0 :デフォルト、1 : FormFillingAllowed、2 : FormFillingAndAnnotationsAllowed、3 : NoChangesAllowed。

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

名前 データ・タイプ デフォルト 概要

ユーザーパスワード ストリング ヌル 入力PDFのユーザーパスワード。 PDF に読み取 り ア ク セ ス を許可す る ためのユーザーパ ス ワー ド があ る 場合は必須。

オーナーパスワード ストリング ヌル 入力 PDF の所有者パスワード。 PDF が所有者パスワー ド を持っ ていて、 変更を行 う ためのア ク セ ス を与え る 場合は必須。

特定のページ 配列[int] ヌル 任意で適用するページを指定する。 空欄の場合、すべてのページが適用されます。

セーブ_アズ_pdfa ブール 偽 PDF/A-3に準拠してPDFを保存します。

save_as_pdfua ブール 偽 PDF/UAに準拠してPDFを保存します。

オプションのヘッダー

名前 データ・タイプ 概要**

著者 ストリング PDF Metadata Authorプロパティを設定します。

タイトル ストリング PDFメタデータタイトルプロパティを設定します。

件名 ストリング PDF Metadata Subjectプロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
CURL

すべての必須およびオプションのパラメータ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

回答：

  • 認証されたPDFファイルを添付して200 OK。

[ポスト] 暗号化／パスワードと権限の追加

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

説明：ユーザーと所有者のパスワードで暗号化することにより、PDF文書にセキュリティの層を追加します。 リクエストボディにpdf_fileオブジェクトとしてPDFファイルを含める。

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

名前 データ・タイプ 概要**

pdfファイル アプリケーション/pdfファイル 暗号化するPDFファイル。

コンテンツの抽出を許可する ブール PDFファイルからコンテンツを抽出できるようにする。

フォーム入力 ブール 出来上がったPDFにフォームを記入できるようにする。

許可_注釈 ブール 出来上がったPDFに注釈を追加したり変更したりできるようにします。

印刷許可 ブール 出来上がったPDFの印刷を許可する。

変更許可 ブール 出来上がったPDFの修正を許可する。

新しいオーナーパスワード ストリング 出力PDFの新しい所有者パスワード。 権限やパスワードの変更を含むフルアクセスを許可する。

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

名前 データ・タイプ デフォルト 概要

ユーザーパスワード ストリング ヌル 入力PDFのユーザーパスワード。 PDF に読み取 り ア ク セ ス を許可す る ためのユーザーパ ス ワー ド があ る 場合は必須。

オーナーパスワード ストリング ヌル 入力 PDF の所有者パスワード。 PDF が所有者パスワー ド を持っ ていて、 変更を行 う ためのア ク セ ス を与え る 場合は必須。

新しいユーザーパスワード ストリング ヌル 出力PDFのための新しいユーザーパスワード。 読み取り権限とその他の指定された権限を与える。

セーブ_アズ_pdfa ブール 偽 PDF/A-3に準拠してPDFを保存します。

save_as_pdfua ブール 偽 PDF/UAに準拠してPDFを保存します。

オプションのヘッダー

名前 データ・タイプ 概要**

著者 ストリング PDF Metadata Authorプロパティを設定します。

タイトル ストリング PDFメタデータタイトルプロパティを設定します。

件名 ストリング PDF Metadata Subjectプロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
CURL

すべての必須およびオプションのパラメータ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

回答：

  • 暗号化されたPDFファイルを添付して200 OK。

[ポスト] ドキュメントからテキストを抽出する

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

説明：文書のページに埋め込まれたテキストを抽出します。 PDF ファイルを pdf_file オブジェクトとしてリクエストボディに含める。

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

名前 データ・タイプ 概要**

pdfファイル アプリケーション/pdfファイル 暗号化するPDFファイル。

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

名前 データ・タイプ デフォルト 概要

ユーザーパスワード ストリング ヌル 入力PDFのユーザーパスワード。 PDF に読み取 り ア ク セ ス を許可す る ためのユーザーパ ス ワー ド があ る 場合は必須。

オーナーパスワード ストリング ヌル 入力 PDF の所有者パスワード。 PDF が所有者パスワー ド を持っ ていて、 変更を行 う ためのア ク セ ス を与え る 場合は必須。

特定のページ 配列[int] ヌル 任意で適用するページを指定する。 空欄の場合、すべてのページが適用されます。

例:

**リクエスト

必須パラメータのみ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
CURL

すべての必須およびオプションのパラメータ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
CURL

回答：

  • 抽出されたテキストをレスポンスとして200 OK。