IronSecureDoc 教學 IronSecureDoc 的 REST API C# 中 IronSecureDoc 的 REST API Curtis Chau 更新:6月 9, 2025 下載 IronSecureDoc 免費下載 開始免費試用 法學碩士副本 法學碩士副本 將頁面複製為 Markdown 格式，用於 LLMs 在 ChatGPT 中打開 請向 ChatGPT 諮詢此頁面 在雙子座打開 請向 Gemini 詢問此頁面 在雙子座打開 請向 Gemini 詢問此頁面 打開困惑 向 Perplexity 詢問有關此頁面的信息 分享 在 Facebook 上分享 分享到 X（Twitter） 在 LinkedIn 上分享 複製連結 電子郵件文章 This article was translated from English: Does it need improvement? Translated View the article in English 這是您的 IronSecureDoc 實例的 REST API 參考文件。 本教學假設您已經有一個正在執行的容器實例。 如果您想開始使用，請按照我們的指南操作。 跳轉至功能介紹： 檢查許可證密鑰 PDF編輯功能 -編輯文字 -編輯正規表示式 -編輯區域 PDF簽名功能 -認證 PDF / 應用數位簽名 -簽署PDF/應用簽名圖片 -驗證證書/簽名 保護 PDF 功能 -對PDF檔案進行加密/新增密碼 -設定PDF權限 -驗證密碼 @@--BRACKET-t-OPEN--@ 所有範例中的 URL 將使用佔位符http://localhost:8080/ 。 請務必將其替換為您的網址。 請務必將佔位符值（例如， path/to/your/file.pdf 、 證書密碼等）替換為實際值。 所有請求範例中都包含作者 、 標題和主題標頭。 @@--括號關閉--@@ [取得] 健康檢查 端點： 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 檔案。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 需要編輯的PDF文件。 待編輯的文字 array[細繩] 需要從文件中刪除的詞語數組。 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 特定頁面 array[int] null 您可以選擇指定要套用的頁面。如果留空，則套用所有頁面。 繪製黑盒 布林值 真的 在已塗黑的文字區域上繪製黑框。 匹配整個單字 布林值 真的 允許對單字中的部分匹配項進行編輯。 區分大小寫 布林值 null 請區分要刪除詞語的大小寫。 疊加文字 細繩 null 如果您希望在編輯區域上顯示疊加文字（例如文字或符號），請在此處設定。如果未設置，則將使用空白字元。 儲存為pdf 布林值 錯誤的 儲存符合 PDF/A-3 標準的 PDF 檔案。 保存為pdfua 布林值 錯誤的 保存符合 PDF/UA 規範的 PDF 檔案。 可選標題 請輸入您的姓名 資料類型 描述 作者 細繩 設定PDF元數據作者屬性。 標題 細繩 設定PDF元資料標題屬性。 主題 細繩 設定PDF元資料主題屬性。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '待編輯的文字=pdf' \ -F '繪製黑盒=true' \ -F '匹配整個單字=true' \ -F '區分大小寫=true' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '待編輯的文字=pdf' \ -F '繪製黑盒=true' \ -F '匹配整個單字=true' \ -F '區分大小寫=true' \ SHELL 所有必填和可選參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '待編輯的文字=word1' \ -F '待編輯的文字=word2' \ -F '繪製黑盒=true' \ -F '匹配整個單字=true' \ -F '區分大小寫=true' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '疊加文字=REDACTED' \ -F '特定頁面=0' \ -F '特定頁面=1' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '待編輯的文字=word1' \ -F '待編輯的文字=word2' \ -F '繪製黑盒=true' \ -F '匹配整個單字=true' \ -F '區分大小寫=true' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '疊加文字=REDACTED' \ -F '特定頁面=0' \ -F '特定頁面=1' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ SHELL Response: 200 OK，已附上編輯後的 PDF 文件。 [帖子] 編輯正規表示式 端點： http://localhost:8080/v1/document-services/pdfs/redact-regular-expression 使用真正的編輯技術，在 PDF 格式文件中隱藏敏感的正規表示式匹配項（例如日期、姓名或模式）。 在請求正文中以pdf文件物件的形式包含 PDF 檔案。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 需要編輯的PDF文件。 正規表示式 細繩 將從文件中刪除與匹配項對應的正規表示式。 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 特定頁面 array[int] null 您可以選擇指定要套用的頁面。如果留空，則套用所有頁面。 繪製黑盒 布林值 真的 在已塗黑的文字區域上繪製黑框。 疊加文字 細繩 null 如果您希望在編輯區域上顯示疊加文字（例如文字或符號），請在此處設定。如果未設置，則將使用空白字元。 儲存為pdf 布林值 錯誤的 儲存符合 PDF/A-3 標準的 PDF 檔案。 保存為pdfua 布林值 錯誤的 保存符合 PDF/UA 規範的 PDF 檔案。 可選標題 請輸入您的姓名 資料類型 描述 作者 細繩 設定PDF元數據作者屬性。 標題 細繩 設定PDF元資料標題屬性。 主題 細繩 設定PDF元資料主題屬性。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '正規表示式="[0-9]"' \ -F '繪製黑盒=true' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '正規表示式="[0-9]"' \ -F '繪製黑盒=true' \ SHELL 所有必填和可選參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '正規表示式="[0-9]"' \ -F '繪製黑盒=true' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '疊加文字=*' \ -F '特定頁面=0' \ -F '特定頁面=1' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '正規表示式="[0-9]"' \ -F '繪製黑盒=true' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '疊加文字=*' \ -F '特定頁面=0' \ -F '特定頁面=1' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ SHELL Response: 200 OK，已附上編輯後的 PDF 文件。 【貼文】編輯區域 端點： http://localhost:8080/v1/document-services/pdfs/redact-region 使用真正的密文技術，隱藏PDF文件特定區域中的敏感文字。 在請求正文中以pdf文件物件的形式包含 PDF 檔案。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/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 座標開始，要編輯區域的高度。 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 特定頁面 array[int] null 您可以選擇指定要套用的頁面。如果留空，則套用所有頁面。 繪製黑盒 布林值 真的 在已塗黑的文字區域上繪製黑框。 儲存為pdf 布林值 錯誤的 儲存符合 PDF/A-3 標準的 PDF 檔案。 保存為pdfua 布林值 錯誤的 保存符合 PDF/UA 規範的 PDF 檔案。 可選標題 請輸入您的姓名 資料類型 描述 作者 細繩 設定PDF元數據作者屬性。 標題 細繩 設定PDF元資料標題屬性。 主題 細繩 設定PDF元資料主題屬性。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@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 '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@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' \ SHELL 所有必填和可選參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=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 '特定頁面=0' \ -F '特定頁面=1' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=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 '特定頁面=0' \ -F '特定頁面=1' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ SHELL Response: 200 OK，已附上編輯後的 PDF 文件。 [帖子] 認證/應用數位簽名 端點： http://localhost:8080/v1/document-services/pdfs/certify 透過證書文件（.p12、.pfx）為 PDF 文件添加認證，以證明該文件未被篡改。 在請求正文中包含一個 PDF 檔案（作為pdf文件物件）和一個憑證檔案（作為certificate_file物件）。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 待認證的PDF文件。 certificate_file application/x-pkcs12 文件 用於認證的證書文件（.p12、.pfx）。 證書密碼 細繩 所提供證書文件的密碼。 證書權限 int 證書權限值 權限 1 不允許任何更改。任何進一步的文件更改都將導致簽名無效。 2 僅允許新增簽名和填寫表格。 3 僅允許新增簽名、填寫表格和新增註釋 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 儲存為pdf 布林值 錯誤的 儲存符合 PDF/A-3 標準的 PDF 檔案。 保存為pdfua 布林值 錯誤的 保存符合 PDF/UA 規範的 PDF 檔案。 可選標題 請輸入您的姓名 資料類型 描述 作者 細繩 設定PDF元數據作者屬性。 標題 細繩 設定PDF元資料標題屬性。 主題 細繩 設定PDF元資料主題屬性。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ SHELL 所有必填和可選參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ SHELL Response: 200 OK，已附上認證的 PDF 檔案。 【貼文】簽名並附上證書 端點： http://localhost:8080/v1/document-services/pdfs/sign 透過證書文件（.p12、.pfx）為 PDF 文件中的圖像添加圖像和證書，以證明該圖像未被篡改。 在請求正文中包含一個 PDF 檔案（作為pdf文件物件）和一個憑證檔案（作為certificate_file物件）。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 待認證的PDF文件。 簽名圖片文件 圖像/jpeg 或圖片/png 文件 用於認證的簽名圖片（.png、.jpg、.jpeg 格式）。可以是標誌、簽名等。 certificate_file application/x-pkcs12 文件 用於認證的證書文件（.p12、.pfx）。 證書密碼 細繩 所提供證書文件的密碼。 證書權限 int 證書權限值 權限 1 不允許任何更改。任何進一步的文件更改都將導致簽名無效。 2 僅允許新增簽名和填寫表格。 3 僅允許新增簽名、填寫表格和新增註釋 特定頁面 int 指定要套用圖像和證書的頁面。首頁為 0。如果留空，則僅套用首頁。 簽名圖像_x float 簽名影像中矩形區域的 X 座標。座標從頁面左上角開始計算。 signature_image_y float 簽名影像中矩形區域的 Y 座標。座標從頁面左上角開始計算。 簽名圖像_w float 簽名影像矩形區域的寬度。該寬度從頁面左上角開始計算。 簽名圖片_h float 簽名影像矩形區域的高度。該高度從頁面左上角開始計算。 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 特定頁面 array[int] null 您可以選擇指定要套用的頁面。如果留空，則套用所有頁面。 儲存為pdf 布林值 錯誤的 儲存符合 PDF/A-3 標準的 PDF 檔案。 保存為pdfua 布林值 錯誤的 保存符合 PDF/UA 規範的 PDF 檔案。 可選標題 請輸入您的姓名 資料類型 描述 作者 細繩 設定PDF元數據作者屬性。 標題 細繩 設定PDF元資料標題屬性。 主題 細繩 設定PDF元資料主題屬性。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '簽名圖片文件=@autograph.png;type=image/png' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ -F '特定頁面=0' \ -F '簽名圖像_x=100' \ -F 'signature_image_y=150' \ -F '簽名圖像_w=500' \ -F '簽名圖片_h=400' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '簽名圖片文件=@autograph.png;type=image/png' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ -F '特定頁面=0' \ -F '簽名圖像_x=100' \ -F 'signature_image_y=150' \ -F '簽名圖像_w=500' \ -F '簽名圖片_h=400' \ SHELL 所有必填和可選參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '簽名圖片文件=@autograph.png;type=image/png' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ -F '特定頁面=0' \ -F '簽名圖像_x=100' \ -F 'signature_image_y=150' \ -F '簽名圖像_w=500' \ -F '簽名圖片_h=400' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '簽名圖片文件=@autograph.png;type=image/png' \ -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \ -F '證書密碼=p4ssw0rd' \ -F '證書權限=1' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ -F '特定頁面=0' \ -F '簽名圖像_x=100' \ -F 'signature_image_y=150' \ -F '簽名圖像_w=500' \ -F '簽名圖片_h=400' \ SHELL Response: 200 OK，已附上認證的 PDF 檔案。 [POST] 驗證簽名 端點： http://localhost:8080/v1/document-services/pdfs/verify-signatures 驗證 PDF 檔案中的簽名是否有效。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 待加密的PDF文件。 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 例子： Request 僅需提供參數： curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@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文件=@sample.pdf;type=application/pdf' \ YAML 所有必填和可選參數： curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ YAML Response: 200 如果簽名齊全且全部有效，則沒問題 如果沒有簽名或至少一個簽名無效，則傳回 400 Bad Request 錯誤。 [POST] 加密/新增密碼和權限 端點： http://localhost:8080/v1/document-services/pdfs/encrypt 使用使用者密碼和擁有者密碼對 PDF 文件進行加密，從而為 PDF 文件增加一層安全性。 在請求正文中以pdf文件物件的形式包含 PDF 檔案。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 待加密的PDF文件。 允許提取內容 布林值 允許從PDF文件中提取內容。 允許表單填寫 布林值 允許在生成的 PDF 文件中填寫表格。 允許註解 布林值 允許在生成的 PDF 文件中新增或修改註釋。 允許列印 布林值 允許列印生成的PDF檔案。 允許修改 布林值 允許對生成的PDF文件進行修改。 新所有者密碼 細繩 為輸出 PDF 檔案設定新的所有者密碼。授予完全存取權限，包括更改權限和密碼。 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 新用戶密碼 細繩 null 為輸出 PDF 檔案設定新的使用者密碼。授予讀取權限和其他指定權限。 儲存為pdf 布林值 錯誤的 儲存符合 PDF/A-3 標準的 PDF 檔案。 保存為pdfua 布林值 錯誤的 保存符合 PDF/UA 規範的 PDF 檔案。 可選標題 請輸入您的姓名 資料類型 描述 作者 細繩 設定PDF元數據作者屬性。 標題 細繩 設定PDF元資料標題屬性。 主題 細繩 設定PDF元資料主題屬性。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '允許提取內容=true' \ -F '允許表單填寫=true' \ -F '允許註解=true' \ -F '允許列印=true' \ -F '允許修改=false' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '允許提取內容=true' \ -F '允許表單填寫=true' \ -F '允許註解=true' \ -F '允許列印=true' \ -F '允許修改=false' \ SHELL 所有必填和可選參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '允許提取內容=true' \ -F '允許表單填寫=true' \ -F '允許註解=true' \ -F '允許列印=true' \ -F '允許修改=false' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '新用戶密碼=p4ssw0rd' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '允許提取內容=true' \ -F '允許表單填寫=true' \ -F '允許註解=true' \ -F '允許列印=true' \ -F '允許修改=false' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '新用戶密碼=p4ssw0rd' \ -F '儲存為pdf=false' \ -F '保存為pdfua=false' \ SHELL Response: 200 OK，已附加加密的 PDF 檔案。 [帖子] 從文件中提取文本 端點： http://localhost:8080/v1/document-services/pdfs/extract 提取嵌入在文件頁面中的文字。 在請求正文中以pdf文件物件的形式包含 PDF 檔案。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 待加密的PDF文件。 可選的請求體參數 請輸入您的姓名 資料類型 預設 描述 使用者密碼 細繩 null 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 null 輸入 PDF 檔案的所有者密碼。如果 PDF 檔案設有所有者密碼，則需要此密碼才能授予存取權限進行修改。 特定頁面 array[int] null 您可以選擇指定要套用的頁面。如果留空，則套用所有頁面。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \ -H 'accept: */*' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@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文件=@sample.pdf;type=application/pdf' \ SHELL 所有必填和可選參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '特定頁面=0' \ -F '特定頁面=1' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ -F '特定頁面=0' \ -F '特定頁面=1' \ SHELL Response: 200 OK，提取的文字作為回應。 [POST] 驗證文件密碼 端點： http://localhost:8080/v1/document-services/pdfs/verify-password 驗證提供的使用者密碼和所有者密碼對pdf文件是否有效。 必需的請求體參數 請輸入您的姓名 資料類型 描述 pdf文件 應用程式/pdf文件 PDF文件。 使用者密碼 細繩 輸入 PDF 的使用者密碼。如果 PDF 檔案需要使用者密碼才能授予讀取權限，則必須輸入此密碼。 所有者密碼 細繩 輸入PDF文件的所有者密碼。 例子： Request 僅需提供參數： curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \ -H 'accept: */*' \ -H '作者: Iron Software | IRONSECUREDOC' \ -H '標題: WEBSITE DEMO 2024' \ -H '主題: DEMO EXAMPLE' \ -H 'Content-Type: multipart/form-data' \ -F 'pdf文件=@sample.pdf;type=application/pdf' \ -F '使用者密碼=password' \ -F '所有者密碼=5yug2RT45th32h78' \ SHELL Response: 200 OK 常見問題解答 IronSecureDoc REST API 的目的是什麼？ IronSecureDoc REST API 旨在透過提供文字刪除、數位簽章應用、文件加密和密碼驗證等功能，協助開發人員保護和管理 PDF 文件。 如何確保我的伺服器可使用 IronSecureDoc API 運作？ 您可以向 `/v1/document-services/ping` 端點傳送 GET 請求，以確保伺服器正常運作。如果成功，伺服器會回應一個 `200 OK` 狀態和訊息 `pong`。 如何使用 API 節錄 PDF 中的特定文字或圖案？ 您可以透過向 `/v1/document-services/pdfs/redact-text` 端點傳送 POST 請求，並附上 PDF 和您想要刪除的文字或正規表示式，來刪除 PDF 中的特定文字或模式。 如何驗證 PDF 的數位簽章是否有效？ 若要驗證 PDF 中的數位簽章，您可以連同 PDF 檔案傳送 POST 請求至 `/v1/document-services/pdfs/verify-signatures` 端點。API 將傳回關於每個簽章有效性的資訊。 使用 IronSecureDoc API 加密 PDF 涉及哪些步驟？ 若要加密 PDF，請將 PDF 檔案傳送至 `/v1/document-services/pdfs/encrypt` 端點的 POST 請求，並指定使用者和所有者密碼，以及您想要設定的任何權限，例如內容擷取或表格填寫。 如何使用 IronSecureDoc API 對 PDF 文件進行數位簽章？ 您可以透過向 `/v1/document-services/pdfs/certify` 端點傳送 POST 請求，並附上 PDF 檔案、數位憑證和憑證密碼，對 PDF 進行數位簽章。 保護 PDF 文件有哪些選項？ 保護 PDF 的選項包括加密文件、設定存取權限、新增使用者和所有者密碼，以及使用 IronSecureDoc API 驗證現有密碼。 是否可以使用 IronSecureDoc API 從 PDF 中提取文字？ 是的，您可以向 `/v1/document-services/pdfs/extract` 端點發送 POST 請求，從 PDF 中提取文字。您可以指定參數，從某些頁面或整個文件中抽取文字。 如何驗證 PDF 文件的密碼？ 若要驗證密碼，請將 PDF 檔案傳送至 `/v1/document-services/pdfs/verify-password` 端點的 POST 請求。請在您的請求中包含使用者和擁有者密碼，以確認其有效性。 IronSecureDoc REST API 的主要功能是什麼？ IronSecureDoc REST API 的主要功能包括伺服器健康檢查、授權驗證、文字編輯、數位簽章應用、PDF 加密和文字萃取。 Curtis Chau 立即與工程團隊聊天 技術作家 Curtis Chau 擁有卡爾頓大學計算機科學學士學位，專注於前端開發，擅長於 Node.js、TypeScript、JavaScript 和 React。Curtis 熱衷於創建直觀且美觀的用戶界面，喜歡使用現代框架並打造結構良好、視覺吸引人的手冊。除了開發之外，Curtis 對物聯網 (IoT) 有著濃厚的興趣，探索將硬體和軟體結合的創新方式。在閒暇時間，他喜愛遊戲並構建 Discord 機器人，結合科技與創意的樂趣。 準備好開始了嗎？ Version: 2024.10 剛發表 免費下載 檢視授權