IronSecureDoc 的 REST API

查克尼思·賓

2024年7月20日

已更新 2024年10月20日

Translated

View the article in English

這是您 IronSecureDoc 實例的 REST API 參考文件。本教程假設您已經有一個正在運行的容器實例，如果您正在尋找要...開始使用請按照我們的指南。

跳至功能：

-檢查授權密鑰

PDF 編輯功能
编辑文本
编辑正则表达式
刪除區域
PDF 簽署功能
签署 PDF / 应用数字签名
签署 PDF / 应用签名图像
驗證憑證 / 簽名
保護 PDF 功能
Encryption/添加密碼至 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：有效

[發布] 抹除文字

端點： http://localhost:8080/v1/document-services/pdfs/redact-text

使用真正的刪減功能隱藏 PDF 格式文件中的敏感詞。在請求正文中將 PDF 文件包含為 pdf_file 對象。

所需請求正文參數

名稱	數據類型	描述
pdf_file	應用程序/pdf 檔案	要編輯的PDF文件。
需要刪除的字詞	陣列[字串]	需要從文件中刪除的單詞陣列。

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 PDF 的擁有者密碼。如果 PDF 設定了擁有者密碼以允許進行修改，則需要提供該密碼。
specific_pages	陣列[整數]	null	可選擇指定應用頁面。如果留空，則將應用於所有頁面。
畫黑色框	布林值	真	在編修文本區域上繪製一個黑框。
完全匹配詞彙	布林值	真	允許單詞內的部分匹配也被編輯。
區分大小寫	布林值	null	匹配要編輯的詞語大小寫。
覆蓋文字	字串	null	如果您希望在修訂區域添加覆蓋文字，例如單詞或符號，請在此處設置。如果不設置，將使用空白字符。
save_as_pdfa	布林值	假	將 PDF 另存為符合 PDF/A-3 標準。
保存為PDF/UA	布林值	假	以 PDF/UA 合規性儲存 PDF。

可選標頭

名稱	數據類型	描述
作者	字串	設置 PDF Metadata Author 屬性。
標題	字串	設置 PDF Metadata Title 屬性。
主旨	字串	設置 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 OK 附上編輯過的 PDF 文件。

[發布] 編輯正則表達式

端點： http://localhost:8080/v1/document-services/pdfs/redact-regular-expression

隱藏敏感的正則表達式匹配結果(例如日期、名稱或模式)以 PDF 格式文件使用真正的遮罩。在請求正文中將 PDF 文件包含為 pdf_file 對象。

所需請求正文參數

名稱	數據類型	描述
pdf_file	應用程序/pdf 檔案	要編輯的PDF文件。
正規表示式	字串	將從文檔中刪除符合的正則表達式匹配案例。

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 PDF 的擁有者密碼。如果 PDF 設定了擁有者密碼以允許進行修改，則需要提供該密碼。
specific_pages	陣列[整數]	null	可選擇指定應用頁面。如果留空，則將應用於所有頁面。
畫黑色框	布林值	真	在編修文本區域上繪製一個黑框。
覆蓋文字	字串	null	如果您希望在修訂區域添加覆蓋文字，例如單詞或符號，請在此處設置。如果不設置，將使用空白字符。
save_as_pdfa	布林值	假	將 PDF 另存為符合 PDF/A-3 標準。
保存為PDF/UA	布林值	假	以 PDF/UA 合規性儲存 PDF。

可選標頭

名稱	數據類型	描述
作者	字串	設置 PDF Metadata Author 屬性。
標題	字串	設置 PDF Metadata Title 屬性。
主旨	字串	設置 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 OK 附上編輯過的 PDF 文件。

[發布] 擦除區域

端點： http://localhost:8080/v1/document-services/pdfs/redact-region

描述：使用真正的刪除技術隱藏 PDF 文件中特定區域的敏感文本。在請求正文中將 PDF 文件包含為 pdf_file 對象。

所需請求正文參數

名稱	數據類型	描述
pdf_file	應用程序/pdf 檔案	要編輯的PDF文件。
region_to_redact_x	浮點數	要遮蔽區域的 X 座標，從頁面的左下角開始。
region_to_redact_y	浮點數	從頁面左下角開始的區域的 Y 座標要遮蓋。
區域_to_redact_w	浮點數	要遮擋區域的寬度，從指定的 X 座標開始。
region_to_redact_h	浮點數	從指定的 Y 座標開始的區域隱藏高度。

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 PDF 的擁有者密碼。如果 PDF 設定了擁有者密碼以允許進行修改，則需要提供該密碼。
specific_pages	陣列[整數]	null	可選擇指定應用頁面。如果留空，則將應用於所有頁面。
畫黑色框	布林值	真	在編修文本區域上繪製一個黑框。
save_as_pdfa	布林值	假	將 PDF 另存為符合 PDF/A-3 標準。
保存為PDF/UA	布林值	假	以 PDF/UA 合規性儲存 PDF。

可選標頭

名稱	數據類型	描述
作者	字串	設置 PDF Metadata Author 屬性。
標題	字串	設置 PDF Metadata Title 屬性。
主旨	字串	設置 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 OK 附上編輯過的 PDF 文件。

[發布] 認證 / 應用數位簽名

端點： http://localhost:8080/v1/document-services/pdfs/certify

描述：将證書添加到 PDF 文件中，以通过證書文件聲明其未被篡改。(.p12，.pfx). 在請求主體中將 PDF 檔案作為 pdf_file 對象包含，並將證書檔案作為 certificate_file 對象包含。

所需請求正文參數

名稱

數據類型

描述

pdf_file

應用程序/pdf 檔案

要認證的 PDF 文件。

證書文件

application/x-pkcs12 檔案

用於認證的證書檔案（.p12, .pfx）。

證書密碼

字串

所提供憑證文件的密碼。

證書權限

整數

certificate_permissions 值	權限
	不允許更改。任何進一步的文件更改都將使簽名無效。
	僅允許額外簽名和表單填寫。
	僅允許附加簽名、填寫表單和註釋

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 PDF 的擁有者密碼。如果 PDF 設定了擁有者密碼以允許進行修改，則需要提供該密碼。
save_as_pdfa	布林值	假	將 PDF 另存為符合 PDF/A-3 標準。
保存為PDF/UA	布林值	假	以 PDF/UA 合規性儲存 PDF。

可選標頭

名稱	數據類型	描述
作者	字串	設置 PDF Metadata Author 屬性。
標題	字串	設置 PDF Metadata Title 屬性。
主旨	字串	設置 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

回應:

200 OK，附有認證的 PDF 檔案。

[發布] 使用簽名和證書簽署文件

端點： http://localhost:8080/v1/document-services/pdfs/sign

描述：將圖像和證書添加到 PDF 文件中的圖像中，以透過證書文件來確認其未被竄改。(.p12，.pfx). 在請求主體中將 PDF 檔案作為 pdf_file 對象包含，並將證書檔案作為 certificate_file 對象包含。

所需請求正文參數

名稱

數據類型

描述

pdf_file

應用程序/pdf 檔案

要認證的 PDF 文件。

簽名圖片檔案

JPEG 或 PNG 檔案

用於認證的簽名圖像（.png、.jpg、.jpeg）。可以是商標、簽名等。

證書文件

application/x-pkcs12 檔案

用於認證的證書檔案（.p12, .pfx）。

證書密碼

字串

所提供憑證文件的密碼。

證書權限

整數

certificate_permissions 值	權限
	不允許更改。任何進一步的文件更改都將使簽名無效。
	僅允許額外簽名和表單填寫。
	僅允許附加簽名、填寫表單和註釋

簽署特定頁面

整數

指定要將圖像和證書應用於的頁面。第一頁為 0。如果留空，則僅應用於第一頁。

signature_image_x

浮點數

簽名圖像矩形區域的 X 座標。這從頁面的左上角開始。

簽名圖像_y

浮點數

簽名圖像矩形區域的 Y 坐標。這從頁面的左上角開始。

簽名_圖像_w

浮點數

簽名影像矩形區域的寬度。這從頁面的左上角開始。

簽名_圖像_h

浮點數

簽名圖像矩形區域的高度。這從頁面的左上角開始。

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 PDF 的擁有者密碼。如果 PDF 設定了擁有者密碼以允許進行修改，則需要提供該密碼。
specific_pages	陣列[整數]	null	可選擇指定應用頁面。如果留空，則將應用於所有頁面。
save_as_pdfa	布林值	假	將 PDF 另存為符合 PDF/A-3 標準。
保存為PDF/UA	布林值	假	以 PDF/UA 合規性儲存 PDF。

可選標頭

名稱	數據類型	描述
作者	字串	設置 PDF Metadata Author 屬性。
標題	字串	設置 PDF Metadata Title 屬性。
主旨	字串	設置 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

回應:

200 OK，附有認證的 PDF 檔案。

[發布] 驗證簽名

端點： http://localhost:8080/v1/document-services/pdfs/verify-signatures

描述：驗證提供的使用者和擁有者密碼是否對 pdf_file 有效。

所需請求正文參數

名稱	數據類型	描述
pdf_file	應用程序/pdf 檔案	要加密的 PDF 文件。

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 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
如果沒有簽名或至少一個簽名無效，則返回 400 BadRequest 結果。

[發布] 加密 / 添加密碼和權限

端點： http://localhost:8080/v1/document-services/pdfs/encrypt

描述：透過為 PDF 文件加上使用者和擁有者密碼進行加密，增加一層安全性。在請求主體中包含一個作為 pdf_file 對象的 PDF 文件。

所需請求正文參數

名稱	數據類型	描述
pdf_file	應用程序/pdf 檔案	要加密的 PDF 文件。
允許提取內容	布林值	允許從 PDF 檔案中提取內容。
允許填寫表單	布林值	允許在生成的 PDF 中填寫表單。
允許註釋	布林值	允許在生成的 PDF 中添加或修改註解。
允許列印	布林值	允許列印生成的 PDF。
允許修改	布林值	允許修改結果 PDF。
new_owner_password	字串	輸出 PDF 的新擁有者密碼。授予完全訪問權限，包括更改許可權和密碼。

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 PDF 的擁有者密碼。如果 PDF 設定了擁有者密碼以允許進行修改，則需要提供該密碼。
new_user_password	字串	null	輸出 PDF 的新用戶密碼。授予閱讀權限和其他指定的權限。
save_as_pdfa	布林值	假	將 PDF 另存為符合 PDF/A-3 標準。
保存為PDF/UA	布林值	假	以 PDF/UA 合規性儲存 PDF。

可選標頭

名稱	數據類型	描述
作者	字串	設置 PDF Metadata Author 屬性。
標題	字串	設置 PDF Metadata Title 屬性。
主旨	字串	設置 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

回應:

200 OK並附有加密的PDF檔案。

[發布] 從文件中提取文本

端點： http://localhost:8080/v1/document-services/pdfs/extract

描述：提取嵌入在文檔頁面中的文本。在請求正文中將 PDF 文件包含為 pdf_file 對象。

所需請求正文參數

名稱	數據類型	描述
pdf_file	應用程序/pdf 檔案	要加密的 PDF 文件。

選擇性請求主體參數

名稱	數據類型	預設	描述
使用者密碼	字串	null	輸入 PDF 的用戶密碼。如果 PDF 設有用戶密碼以授予讀取權限，則必須提供。
擁有者密碼	字串	null	輸入 PDF 的擁有者密碼。如果 PDF 設定了擁有者密碼以允許進行修改，則需要提供該密碼。
specific_pages	陣列[整數]	null	可選擇指定應用頁面。如果留空，則將應用於所有頁面。

範例：

請求

僅限必填參數：

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	應用程序/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

回應: