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/ 的佔位符將用於所有範例中的網址。請確保將其替換為您的網址。
  • 請務必替換佔位符值 (例如, 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_file 對象包含一個 PDF 文件。

必要的請求主體參數

名稱
資料類型
描述

pdf_file
application/pdf 檔案
要編輯的 PDF 檔案。

words_to_redact
陣列[字串]
要從文檔中刪除的詞彙數組。

選擇性請求主體參數

名稱 數據類型 預設值 描述

user_password string null 輸入 PDF 的用戶密碼。如果 PDF 具有用戶密碼以授予讀取權限，則需要提供。

owner_password string null 輸入 PDF 的擁有者密碼。如果 PDF 具有擁有者密碼以授予修改權限，則需要提供。

specific_pages array[整數] null 可選擇指定要應用的頁面。如果留空，將應用於所有頁面。

draw_black_box bool True 在被編輯的文字區域上畫一個黑框。

match_whole_word bool True 允許部分匹配的單詞也被編輯。

match_case bool null 匹配需要編輯的單詞的大小寫。

overlay_text string null 如果您希望在編輯區域上覆蓋文字，例如單詞或符號，請在此設置。如果未設置，將使用空白字符。

save_as_pdfa bool False 以符合PDF/A-3的規範儲存PDF。

save_as_pdfua bool False 以符合PDF/UA的規範儲存PDF。

選擇性標題

名稱
數據類型
描述

author
string
設置 PDF Metadata Author 屬性。

title
string
設置 PDF Metadata Title 屬性。

subject
string
設置 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 檔案。

[發布] 使用正則表達式進行修訂

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

隱藏敏感的正則表達式匹配 (例如日期、名稱或模式) 使用真實修訂在 PDF 格式文檔中。請在請求正文中包含一個作為 pdf_file 對象的 PDF 文件。

必需的請求主體參數

名稱
資料類型
描述

pdf_file
application/pdf 文件
要編輯的 PDF 文件。

regular_expression
string
將文件中匹配的情況編輯掉的正則表達式。

選擇性請求主體參數

名稱 數據類型 預設值 描述

user_password string null 輸入 PDF 的用戶密碼。如果 PDF 具有用戶密碼以授予讀取權限，則需要提供。

owner_password string null 輸入 PDF 的擁有者密碼。如果 PDF 具有擁有者密碼以授予修改權限，則需要提供。

specific_pages array[整數] null 可選擇指定要應用的頁面。如果留空，將應用於所有頁面。

draw_black_box bool True 在被編輯文本區域繪製黑色框。

overlay_text string null 如果您希望在編輯區域上疊加文字（例如單詞或符號），請在此設置。如果不設置，將使用空白字符。

save_as_pdfa bool False 以符合PDF/A-3標準保存PDF。

save_as_pdfua bool False 以符合PDF/UA標準保存PDF。

選擇性標題

名稱
數據類型
描述

author
string
設置 PDF Metadata Author 屬性。

title
string
設置 PDF Metadata Title 屬性。

subject
string
設置 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 檔案。

[發布] 遮蓋區域

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

描述： 使用真正的遮蓋功能隱藏PDF文檔中特定區域的敏感文本。在請求正文中包含作為 pdf_file 對象的 PDF 文件。

必要的請求正文參數

名稱
數據類型
描述

pdf_file
application/pdf 檔案
需要遮蔽的PDF檔案。

region_to_redact_x
float
遮蔽區域的X座標，從頁面的左下方開始。

region_to_redact_y
float
遮蔽區域的Y座標，從頁面的左下方開始。

region_to_redact_w
float
遮蔽區域的寬度，從指定的X座標開始。

region_to_redact_h
float
遮蔽區域的高度，從指定的Y座標開始。

選擇性請求主體參數

名稱 數據類型 預設值 描述

user_password string null 輸入 PDF 的用戶密碼。如果 PDF 具有用戶密碼以授予讀取權限，則需要提供。

owner_password string null 輸入 PDF 的擁有者密碼。如果 PDF 具有擁有者密碼以授予修改權限，則需要提供。

specific_pages array[整數] null 可選擇性地指定要應用的頁面。如果留空，將應用於所有頁面。

draw_black_box bool 真 在被刪除的文字區域繪製黑框。

save_as_pdfa bool 假 保存為符合PDF/A-3標準的PDF。

save_as_pdfua bool 假 保存為符合PDF/UA標準的PDF。

選擇性標題

名稱
數據類型
描述

author
string
設置 PDF Metadata Author 屬性。

title
string
設置 PDF Metadata Title 屬性。

subject
string
設置 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 檔案。

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

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

說明：透過證書文件添加認證到 PDF 文件，以確保其未被篡改 (.p12，.pfx)將 PDF 文件作為 pdf_file 對象包含在請求正文中，將證書文件作為 certificate_file 對象包含在請求正文中。

所需請求正文參數

名稱 數據類型 描述

pdf_file application/pdf 文件 需要認證的 PDF 文件。

certificate_file application/x-pkcs12 文件 證書文件 (.p12，.pfx) 用於證書。

certificate_password 字串 提供的證書文件的密碼。

certificate_permissions 整數 認證的許可權類型：0：預設，1：允許填寫表單，2：允許填寫表單及註釋，3：不允許更改

選擇性請求主體參數

名稱 數據類型 預設值 描述

user_password string null 輸入 PDF 的用戶密碼。如果 PDF 具有用戶密碼以授予讀取權限，則需要提供。

owner_password string null 輸入 PDF 的擁有者密碼。如果 PDF 具有擁有者密碼以授予修改權限，則需要提供。

specific_pages array[整數] null 選擇性地指定要應用的頁面。如果留空，將應用所有頁面。

save_as_pdfa bool False 將 PDF 保存為符合 PDF/A-3 標準。

save_as_pdfua bool False 將 PDF 保存為符合 PDF/UA 標準。

選擇性標題

名稱
數據類型
描述

author
string
設置 PDF Metadata Author 屬性。

title
string
設置 PDF Metadata Title 屬性。

subject
string
設置 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

回應：

  • 200 確定並附上已認證的 PDF 檔案。

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

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

描述： 透過用戶和擁有者密碼加密PDF文檔，為其增加一層安全保護。在請求體中包含作為pdf_file對象的PDF文件。

所需請求正文參數

名稱 數據類型 描述

pdf_file
application/pdf 文件
要加密的 PDF 文件。

allow_extracting_content
布林值
允許從 PDF 文件中提取內容。

allow_form_filling
布林值
允許在生成的 PDF 中填寫表單。

allow_annotations
布林值
允許在生成的 PDF 中添加或修改註釋。

allow_printing
布林值
允許打印生成的 PDF。

allow_modifications
布林值
允許對生成的 PDF 進行修改。

new_owner_password
字符串
輸出 PDF 的新擁有者密碼。授予完全訪問權，包括更改權限和密碼。

選擇性請求正文參數

名稱 數據類型 默認值 描述

user_password string null 輸入 PDF 的用戶密碼。如果 PDF 有用戶密碼以授予讀取訪問權限，則必填。

owner_password string null 輸入 PDF 的所有者密碼。如果 PDF 有所有者密碼以授予修改權限，則必填。

new_user_password string null 輸出 PDF 的新用戶密碼。授予讀取訪問權限和其他指定的權限。

save_as_pdfa bool False 將 PDF 保存為兼容 PDF/A-3。

save_as_pdfua bool False 將 PDF 保存為兼容 PDF/UA。

選擇性標題

名稱
數據類型
描述

author
string
設置 PDF Metadata Author 屬性。

title
string
設置 PDF Metadata Title 屬性。

subject
string
設置 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

回應：

  • 200 OK，附上加密的 PDF 檔案。

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

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

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

必填請求主體參數

名稱
數據類型
描述

pdf_file
application/pdf 文件
要加密的 PDF 文件。

選擇性請求主體參數

名稱 數據類型 預設值 描述

user_password string null 輸入 PDF 的用戶密碼。如果 PDF 具有用戶密碼以授予讀取權限，則需要提供。

owner_password string null 輸入 PDF 的擁有者密碼。如果 PDF 具有擁有者密碼以授予修改權限，則需要提供。

specific_pages array[整數] 空
選擇性地指定要應用的頁面。如果留空，則將應用所有頁面。

範例：

請求

僅限必填參數：

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，包含擷取的文本作為回應。