IronSecureDocのREST API

Translated

View the article in English

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

機能にジャンプする：

ライセンスキーを確認
PDFの墨消し機能
- テキストの再編集
- 正規表現の再編集
領域の編集
PDF署名機能
- PDFの認証 / デジタル署名の適用
- PDFに署名 / 署名画像を適用
証明書/署名を確認する
PDF機能を保護する
ヒント
http://localhost:8080/`のプレースホルダーは、すべての例でURLに使用されます。あなたのURLに置き換えてください。
プレースホルダーの値は必ず置き換えてください。(例：path/to/your/file.pdf、certificate_passwordなど。)を実際の値で示す。
author、title、subject` ヘッダはすべてのリクエスト例に含まれています。

[ゲット] 健康チェック

エンドポイント： 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_file	application/pdf ファイル	編集するPDFファイル。
ワード_トゥ_リダクト	配列[文字列]	文書から編集されるべき単語の配列。

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。
specific_pages	配列[整数]	ヌル	オプションで適用するページを指定できます。空白の場合、すべてのページに適用されます。
draw_black_box	ブール	真	編集されたテキスト領域にブラックボックスを描画します。
match_whole_word	ブール	真	単語内の部分一致も削除できるようにします。
一致ケース	ブール	ヌル	赤文字として修正する単語の大文字小文字を区別します。
オーバーレイテキスト	文字列	ヌル	編集領域に文字や記号のオーバーレイテキストを希望する場合は、ここに設定してください。設定されていない場合は、空白文字が使用されます。
PDF/Aとして保存	ブール	偽	PDF/A-3準拠でPDFを保存します。
save_as_pdfua	ブール	偽	PDF/UA準拠でPDFを保存します。

オプションのヘッダー

名前	データ型	説明
著者	文字列	PDFのメタデータの著者プロパティを設定します。
タイトル	文字列	PDFメタデータのタイトルプロパティを設定します。
件名	文字列	PDFメタデータの件名プロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

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 -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 -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_file	application/pdf ファイル	編集するPDFファイル。
正規表現	文字列	一致するケースが文書から編集される正規表現。

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。
specific_pages	配列[整数]	ヌル	オプションで適用するページを指定できます。空白の場合、すべてのページに適用されます。
draw_black_box	ブール	真	編集されたテキスト領域にブラックボックスを描画します。
オーバーレイテキスト	文字列	ヌル	編集領域に文字や記号のオーバーレイテキストを希望する場合は、ここに設定してください。設定されていない場合は、空白文字が使用されます。
PDF/Aとして保存	ブール	偽	PDF/A-3準拠でPDFを保存します。
save_as_pdfua	ブール	偽	PDF/UA準拠でPDFを保存します。

オプションのヘッダー

名前	データ型	説明
著者	文字列	PDFのメタデータの著者プロパティを設定します。
タイトル	文字列	PDFメタデータのタイトルプロパティを設定します。
件名	文字列	PDFメタデータの件名プロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

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 -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 -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_file	application/pdf ファイル	編集するPDFファイル。
region_to_redact_x	浮動小数点数	ページの左下から始まる、編集対象領域のX座標。
region_to_redact_y	浮動小数点数	ページの左下から始まる、マスキングする領域のY座標。
領域_to_redact_w	浮動小数点数	指定されたX座標から始まる、赤字処理する領域の幅。
リージョンを非表示にするための h	浮動小数点数	指定されたY座標から始まる、編集する領域の高さ。

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。
specific_pages	配列[整数]	ヌル	オプションで適用するページを指定できます。空白の場合、すべてのページに適用されます。
draw_black_box	ブール	真	編集されたテキスト領域にブラックボックスを描画します。
PDF/Aとして保存	ブール	偽	PDF/A-3準拠でPDFを保存します。
save_as_pdfua	ブール	偽	PDF/UA準拠でPDFを保存します。

オプションのヘッダー

名前	データ型	説明
著者	文字列	PDFのメタデータの著者プロパティを設定します。
タイトル	文字列	PDFメタデータのタイトルプロパティを設定します。
件名	文字列	PDFメタデータの件名プロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

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 -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 -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_file

application/pdf ファイル

認証するPDFファイル。

certificate_file

application/x-pkcs12 ファイル

認証に使用する証明書ファイル（.p12、.pfx）。

certificate_password

文字列

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

certificate_permissions

int

certificate_permissions 値	権限
	変更は許可されていません。これ以上の文書の変更は署名を無効にします。
	追加の署名とフォーム入力のみ許可されています。
	追加署名、フォーム入力、注釈のみ許可

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。
PDF/Aとして保存	ブール	偽	PDF/A-3準拠でPDFを保存します。
save_as_pdfua	ブール	偽	PDF/UA準拠でPDFを保存します。

オプションのヘッダー

名前	データ型	説明
著者	文字列	PDFのメタデータの著者プロパティを設定します。
タイトル	文字列	PDFメタデータのタイトルプロパティを設定します。
件名	文字列	PDFメタデータの件名プロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

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=1' \

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=1' \

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=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

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=1' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \

CURL

回答：

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

[ポスト] 署名と証明書でサインする

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

説明: イメージを追加し、PDFドキュメント内のそのイメージに証明書を付与して、証明書ファイルを使用して改ざんされていないことを主張します。(.p12, .pfx). PDFファイルを pdf_file オブジェクトとしてリクエストボディに、証明書ファイルを certificate_file オブジェクトとしてリクエストボディに含める。

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

名前

データ型

説明

pdf_file

application/pdf ファイル

認証するPDFファイル。

署名画像ファイル

image/jpeg または image/png ファイル

認証に使用する署名画像（.png、.jpg、.jpeg）。ロゴや自署などに使用できます。

certificate_file

application/x-pkcs12 ファイル

認証に使用する証明書ファイル（.p12、.pfx）。

certificate_password

文字列

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

certificate_permissions

int

certificate_permissions 値	権限
	変更は許可されていません。これ以上の文書の変更は署名を無効にします。
	追加の署名とフォーム入力のみ許可されています。
	追加署名、フォーム入力、注釈のみ許可

sign_specific_page

int

画像と証明書を適用するページを指定してください。最初のページは0です。空白の場合は、最初のページにのみ適用されます。

署名画像_x

浮動小数点数

署名画像の長方形領域のX座標。この座標はページの左上から始まります。

署名画像_y

浮動小数点数

署名画像の矩形領域のY座標。この座標はページの左上から始まります。

署名画像_w

浮動小数点数

署名画像の長方形領域の幅。この幅はページの左上から始まります。

署名画像_h

浮動小数点数

署名画像の矩形領域の高さです。これはページの左上から始まります。

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。
specific_pages	配列[整数]	ヌル	オプションで適用するページを指定できます。空白の場合、すべてのページに適用されます。
PDF/Aとして保存	ブール	偽	PDF/A-3準拠でPDFを保存します。
save_as_pdfua	ブール	偽	PDF/UA準拠でPDFを保存します。

オプションのヘッダー

名前	データ型	説明
著者	文字列	PDFのメタデータの著者プロパティを設定します。
タイトル	文字列	PDFメタデータのタイトルプロパティを設定します。
件名	文字列	PDFメタデータの件名プロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'signature_image_file=@autograph.png;type=image/png' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=1' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

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

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -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 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -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 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
  -F 'sign_specific_page=0' \
  -F 'signature_image_x=100' \
  -F 'signature_image_y=150' \
  -F 'signature_image_w=500' \
  -F 'signature_image_h=400' \

CURL

回答：

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

[ポスト] 署名を確認する

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

説明: 提供されたユーザーパスワードと所有者のパスワードが pdf_file に対して有効であることを確認します。

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

名前	データ型	説明
pdf_file	application/pdf ファイル	暗号化するPDFファイル。

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。

例:

**リクエスト

必須パラメータのみ：

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \

YAML

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

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -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"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -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"' \

YAML

回答：

署名があり、すべて有効であれば200 OK
署名がないか、少なくとも1つが無効な場合、400 BadRequest 結果が発生します。

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

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

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

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

名前	データ型	説明
pdf_file	application/pdf ファイル	暗号化するPDFファイル。
コンテンツの抽出を許可	ブール	PDFファイルからコンテンツを抽出できるようにします。
フォーム入力を許可	ブール	結果のPDFでフォームの記入を許可する。
アノテーションを許可する	ブール	生成されるPDFに注釈の追加または変更を許可します。
印刷を許可	ブール	生成されたPDFの印刷を許可する。
変更を許可する	ブール	結果のPDFを変更できるようにします。
new_owner_password	文字列	出力PDFの新しいオーナーパスワード。権限やパスワードの変更を含む、完全なアクセス権を付与します。

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。
new_user_password	文字列	ヌル	出力PDFの新しいユーザーパスワード。読み取りアクセスやその他の指定された権限を付与します。
PDF/Aとして保存	ブール	偽	PDF/A-3準拠でPDFを保存します。
save_as_pdfua	ブール	偽	PDF/UA準拠でPDFを保存します。

オプションのヘッダー

名前	データ型	説明
著者	文字列	PDFのメタデータの著者プロパティを設定します。
タイトル	文字列	PDFメタデータのタイトルプロパティを設定します。
件名	文字列	PDFメタデータの件名プロパティを設定します。

例:

**リクエスト

必須パラメータのみ：

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 -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 -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_file	application/pdf ファイル	暗号化するPDFファイル。

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

名前	データ型	デフォルト	説明
ユーザー_パスワード	文字列	ヌル	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	ヌル	入力PDFのオーナーパスワード。変更を行うためのアクセス権を付与する必要がある場合、PDFにオーナーパスワードが設定されている必要があります。
specific_pages	配列[整数]	ヌル	オプションで適用するページを指定できます。空白の場合、すべてのページに適用されます。

例:

**リクエスト

必須パラメータのみ：

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 -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 -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。

[ポスト] ドキュメントパスワードを確認

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

説明: 提供されたユーザーパスワードと所有者のパスワードが pdf_file に対して有効であることを確認します。

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

名前	データ型	説明
pdf_file	application/pdf ファイル	PDFファイル。
ユーザー_パスワード	文字列	入力PDFのユーザーパスワード。PDFに読み取りアクセスを許可するユーザーパスワードがある場合に必要です。
オーナーパスワード	文字列	入力PDFのオーナーパスワード。

例:

**リクエスト

必須パラメータのみ：

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -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"' \

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
  -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"' \

YAML

回答：

200 OK

IronSecureDocのREST API

機能にジャンプする：

ヒント

[ゲット] 健康チェック

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

[ポスト] テキストの再編集

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

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

オプションのヘッダー

例:

必須パラメータのみ：

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

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

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

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

オプションのヘッダー

例:

必須パラメータのみ：

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

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

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

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

オプションのヘッダー

例:

必須パラメータのみ：

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

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

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

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

オプションのヘッダー

例:

必須パラメータのみ：

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

[ポスト] 署名と証明書でサインする

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

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

オプションのヘッダー

例:

必須パラメータのみ：

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

[ポスト] 署名を確認する

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

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

例:

必須パラメータのみ：

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

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

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

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

オプションのヘッダー

例:

必須パラメータのみ：

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

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

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

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

例:

必須パラメータのみ：

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

[ポスト] ドキュメントパスワードを確認

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

例:

必須パラメータのみ：

試用フォームが送信されました成功しました.

ライブ環境でテストする

完全に機能する製品

24/5 テクニカルサポート

無料で取得 0日間の試用キー 即座に。

試用フォームが送信されました成功しました.

世界中の何百万人ものエンジニアに信頼されています

ライブ環境でテストする

完全に機能する製品

24/5 テクニカルサポート

無料で取得 0日間の試用キー 即座に。

世界中の何百万人ものエンジニアに信頼されています

IronSecureDoc は IRONSUITEUNLIMITED の一部です。

試用フォームが送信されました
成功しました.

無料で取得 0日間の試用キー即座に。

試用フォームが送信されました
成功しました.

無料で取得 0日間の試用キー即座に。