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.pdfcertificate_password等)替換為實際值。
  • 所有請求範例中都包含authortitlesubject標頭。
    @@--括號關閉--@@

[取得] 健康檢查

端點: 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 請求。API 將返回每個簽名的有效性信息。

使用 IronSecureDoc API 加密 PDF 涉及哪些步驟?

要加密 PDF,請將 PDF 文件發送到 `/v1/document-services/pdfs/encrypt` 端點的 POST 請求,指定使用者和擁有者密碼以及任何需要設定的權限,例如內容提取或表單填寫。

如何使用 IronSecureDoc API 為 PDF 文件進行數位簽名?

您可以將 PDF 文件、數位證書和證書密碼發送到 `/v1/document-services/pdfs/certify` 端點的 POST 請求來為 PDF 進行數位簽名。

有哪些選項可用於保護 PDF 文檔?

保護 PDF 的選項包括加密文件、設置訪問權限、添加使用者和擁有者密碼以及使用 IronSecureDoc API 驗證現有密碼。

使用 IronSecureDoc API 是否可以從 PDF 提取文本?

是的,您可以發送 POST 請求到 `/v1/document-services/pdfs/extract` 端點來從 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 剛發表