1. IronSecureDoc
  2. 教學
  3. IronSecureDoc 的 REST API

C# 中 IronSecureDoc 的 REST API

柯蒂斯·週
柯蒂斯·週
更新:
This article was translated from English: Does it need improvement?
Translated
View the article in English

這是您的 IronSecureDoc 實例的 REST API 參考文件。 本教學假設您已經有一個正在執行的容器實例。 如果您想開始使用，請按照我們的指南操作。

跳轉至功能介紹：

檢查許可證密鑰

[{t:(@

  • 所有範例中的 URL 將使用佔位符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`應用程式/pdf文件需要編輯的PDF文件。
`words_to_redact`陣列[字串］需要從文件中刪除的詞語數組。

常見問題解答

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 中的數位簽名，您可以向 `/v1/document-services/pdfs/verify-signatures` 端點發送 POST 請求，並附上 PDF 檔案。 API 將傳回每個簽章的有效性資訊。

使用 IronSecureDoc API 加密 PDF 檔案需要哪些步驟？

若要加密 PDF，請向 `/v1/document-services/pdfs/encrypt` 端點發送 POST 請求，並附上 PDF 文件，指定使用者和所有者密碼以及您想要設定的任何權限，例如內容提取或表單填寫。

如何使用 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文件中的密碼？

若要驗證密碼，請向 `/v1/document-services/pdfs/verify-password` 端點發送 POST 請求，並附上 PDF 檔案。請求中需同時包含使用者密碼和所有者密碼，以確認其有效性。

IronSecureDoc REST API 的主要功能有哪些？

IronSecureDoc REST API 的主要功能包括伺服器健康檢查、許可證驗證、文字編輯、數位簽章應用程式、PDF 加密和文字擷取。

柯蒂斯·週
柯蒂斯·週
  現在就和工程團隊聊天吧
技術撰稿人

Curtis Chau擁有卡爾頓大學電腦科學學士學位，專長於前端開發，精通Node.js、TypeScript、JavaScript和React。他熱衷於打造直覺美觀的使用者介面，喜歡使用現代框架，並擅長撰寫結構清晰、視覺效果出色的使用者手冊。

除了開發工作之外，柯蒂斯對物聯網 (IoT) 也抱有濃厚的興趣，致力於探索硬體和軟體整合的創新方法。閒暇時，他喜歡玩遊戲和製作 Discord 機器人，將他對科技的熱愛與創造力結合。

準備好開始了嗎？
版本： 2024.10 剛剛發布