IronSecureDocのREST API

チャクニット・ビン

2024年7月20日

更新済み 2024年10月20日

共有:

Translated

View the article in English

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

機能にジャンプする：

ライセンスキーの確認
PDFの墨消し機能
- テキストの編集
- 正規表現の編集
リージョンを削除
PDF署名機能
- PDFを認証 / デジタル署名を適用
- PDFに署名 / 署名画像を適用
証明書／署名を確認
PDF機能を保護する
[{t:(
すべての例で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

[POST] テキストの再編集

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

真の再編集を使用してPDF形式の文書内の機密性の高い単語を隠します。リクエストボディにpdf_fileオブジェクトとしてPDFファイルを含めます。

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

名前

データタイプ	説明
pdf_file	application/pdfファイル	編集するPDFファイル。
words_to_redact	配列[string]	ドキュメントから編集される単語の配列。

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

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
draw_black_box	bool	True	Have a Black Box drawn over redacted text areas.
match_whole_word	bool	True	Allow partial matches within words be redacted too.
match_case	bool	null	Match case for the words to be redacted.
overlay_text	string	null	If your prefer an Overlay Text on the redaction area such as words or symbols, set them here. If not set, a blank character will be used.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

オプションのヘッダー

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

例:

リクエスト

必須パラメータのみ：

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。

[POST] 正規表現の変更

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

正しい編集を使用して、PDF形式のドキュメント内の機密性の高い正規表現の一致（例：日付、名前、パターン）を隠します。リクエストボディにpdf_fileオブジェクトとしてPDFファイルを含めます。

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

名前	データ型	説明
pdf_file	application/pdf ファイル	修正する PDF ファイル。
regular_expression	文字列	ドキュメントから一致するケースが修正される正規表現。

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

名前	データ型	デフォルト	説明
user_password	string	null	入力PDFのためのユーザーパスワード。PDFが読み取りアクセスを許可するユーザーパスワードを持っている場合に必要です。
owner_password	string	null	入力PDFのためのオーナーパスワード。PDFが修正のアクセスを許可するオーナーパスワードを持っている場合に必要です。
specific_pages	array[int]	null	適用するページをオプションで指定します。空の場合、すべてのページに適用されます。
draw_black_box	bool	True	秘匿されたテキスト領域にブラックボックスが描かれます。
overlay_text	string	null	秘匿領域にオーバーレイテキストを設定したい場合、ここに単語や記号を設定します。設定しない場合、空白文字が使用されます。
save_as_pdfa	bool	False	PDFをPDF/A-3基準で保存します。
save_as_pdfua	bool	False	PDFをPDF/UA基準で保存します。

オプションのヘッダー

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

例:

リクエスト

必須パラメータのみ：

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。

[POST] リージョンの再編集

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

説明: 真の墨消しを使用してPDFドキュメントの特定の領域で機密テキストを隠します。リクエストボディにpdf_fileオブジェクトとしてPDFファイルを含めます。

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

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to redact.
region_to_redact_x	float	X coordinate of the region to redact, starting from the bottom-left of the page.
region_to_redact_y	float	Y coordinate of the region to redact, starting from the bottom-left of the page.
region_to_redact_w	float	Width of the region to redact, starting from the specified X coordinate.
region_to_redact_h	float	Height of the region to redact, starting from the specified Y coordinate.

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

名前	データ型	デフォルト	説明
user_password	string	null	入力PDFのユーザーパスワード。 PDFに読み取りアクセスを許可するためのユーザーパスワードがある場合に必要です。
owner_password	string	null	入力PDFのオーナーパスワード。 PDFの変更を行うためのパスワードがある場合に必要です。
specific_pages	array[int]	null	適用するページを指定するオプションです。空のままにすると、すべてのページが適用されます。
draw_black_box	bool	True	無効化されたテキスト領域に黒いボックスを描画します。
save_as_pdfa	bool	False	PDF/A-3準拠のPDFとして保存します。
save_as_pdfua	bool	False	PDF/UA準拠のPDFとして保存します。

オプションのヘッダー

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

例:

リクエスト

必須パラメータのみ：

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。

[POST] 電子署名の認証/適用

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

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

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

名前

pdf_file

application/pdf file

The PDF file to certify.

certificate_file

application/x-pkcs12 file

The certificate file (.p12, .pfx) to use for certification.

certificate_password

string

Password for the provided certificate file.

certificate_permissions

int

certificate_permissions value	Permissions
1	No Changes Allowed. Any further document changes will invalidate the signature.
2	Only Additional Signatures and Form Filling Allowed.
3	Only AdditionalSignatures, Form Filling, and Annotations Allowed

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

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

オプションのヘッダー

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

例:

リクエスト

必須パラメータのみ：

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。

[POST] 署名と証明書でサインする

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

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

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

名前

pdf_file

application/pdf file

The PDF file to certify.

signature_image_file

image/jpeg or image/png file

The signature image (.png, .jpg, .jpeg) to use for certification. Can be a logo, autograph, etc.

certificate_file

application/x-pkcs12 file

The certificate file (.p12, .pfx) to use for certification.

certificate_password

string

Password for the provided certificate file.

certificate_permissions

int

certificate_permissions value	Permissions
1	No Changes Allowed. Any further document changes will invalidate the signature.
2	Only Additional Signatures and Form Filling Allowed.
3	Only AdditionalSignatures, Form Filling, and Annotations Allowed

sign_specific_page

int

Specify page to apply the image and certificate to. First page is 0. If left empty, only first page will apply.

signature_image_x

float

The X coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_y

float

The Y coordinate of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_w

float

The Width of the Rectangle region of the signature image. This starts from the top-left of the page.

signature_image_h

float

The Height of the Rectangle region of the signature image. This starts from the top-left of the page.

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

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

オプションのヘッダー

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

例:

リクエスト

必須パラメータのみ：

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。

[POST] 署名を確認する

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

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

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

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.

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

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.

例:

リクエスト

必須パラメータのみ：

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 結果が発生します。

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

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

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

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

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.
allow_extracting_content	bool	Allow the extraction of content from the PDF file.
allow_form_filling	bool	Allow the filling of forms in the resulting PDF.
allow_annotations	bool	Allow the addition or modification of annotations in the resulting PDF.
allow_printing	bool	Allow printing of the resulting PDF.
allow_modifications	bool	Allow modifications to the resulting PDF.
new_owner_password	string	New owner password for the output PDF. Grants full access, including changing permissions and passwords.

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

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
new_user_password	string	null	New user password for the output PDF. Grants read access and other specified permissions.
save_as_pdfa	bool	False	Save the PDF with PDF/A-3 compliance.
save_as_pdfua	bool	False	Save the PDF with PDF/UA compliance.

オプションのヘッダー

Name	Data Type	Description
author	string	Set the PDF Metadata Author property.
title	string	Set the PDF Metadata Title property.
subject	string	Set the PDF Metadata Subject property.

例:

リクエスト

必須パラメータのみ：

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。

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

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

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

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

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file to encrypt.

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

Name	Data Type	Default	Description
user_password	string	null	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	null	Owner password for the input PDF. Required if the PDF has an owner password to grant access to make modifications.
specific_pages	array[int]	null	Optionally specify pages to apply to. If left empty, all pages will apply.

例:

リクエスト

必須パラメータのみ：

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。

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

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

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

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

Name	Data Type	Description
pdf_file	application/pdf file	The PDF file.
user_password	string	User password for the input PDF. Required if the PDF has a user password to grant read access.
owner_password	string	Owner password for the input 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

応答：