REST API for IronSecureDoc in C

This article was translated from English: Does it need improvement?
Translated
View the article in English

這是您 IronSecureDoc 實例的 REST API 參考手冊。 本教學假設您已有一台正在運行的容器實例。 若您想開始使用,請參閱我們的指南。

跳至功能:

提示

  • 所有範例中的 URL 將使用 http://localhost:8080/ 作為佔位符。 請務必將此處替換為您的網址。
  • 請務必將佔位符值(例如 certificate_password 等)替換為實際值。
  • 所有請求範例中均包含 titlesubject 標頭。 )}]

[GET] 狀態檢查

Endpoint: http://localhost:8080/v1/document-services/ping

健康檢查端點,用於驗證伺服器是否正在運行。

回應:200 OK:pong


[GET] 檢查授權

Endpoint: http://localhost:8080/v1/document-services/check-license

驗證授權的有效性。

回應:200 OK:Valid


[POST] 隱藏文字

Endpoint: http://localhost:8080/v1/document-services/pdfs/redact-text

使用真正的遮蔽技術,在 PDF 格式文件中隱藏敏感字詞。 請將 PDF 檔案作為 pdf_file 物件包含在請求主體中。

必填請求主體參數

名稱資料型別描述
pdf_fileapplication/pdf 檔案待編輯的 PDF 檔案。
words_to_redactarray[string]文件中需刪除的一系列詞彙。

常見問題

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 文件發送到 `/v1/document-services/pdfs/verify-signatures` 端點的 POST 請求。API 會返回每個簽章的有效性資訊。

using 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 驗證現有密碼。

using 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擁有Carleton大學的電腦科學學士學位,專精於前端開發,擁有Node.js、TypeScript、JavaScript和React的專業知識。Curtis熱衷於建立直觀且美觀的使用者介面,喜愛使用現代框架並建立結構良好、視覺吸引力的手冊。

除了開發,Curtis對物聯網(IoT)有濃厚的興趣,探索創新的方法來整合硬體和軟體。在空閒時間,他喜歡玩遊戲和建立Discord機器人,結合他對技術的熱愛與創造力。

準備開始了嗎?
版本: 2024.10 剛剛發布
Still Scrolling Icon

還在滾動嗎?

想要快速證明嗎?
運行一個樣本觀看您的PDF加密。