REST API for IronSecureDoc in C
這是您 IronSecureDoc 實例的 REST API 參考手冊。 本教學假設您已有一台正在運行的容器實例。 若您想開始使用,請參閱我們的指南。
跳至功能:
- 檢查授權金鑰
- PDF 遮蔽功能
- PDF 簽名功能
- 保護 PDF 功能
- 所有範例中的 URL 將使用
http://localhost:8080/作為佔位符。 請務必將此處替換為您的網址。 - 請務必將佔位符值(例如
certificate_password等)替換為實際值。 - 所有請求範例中均包含
title及subject標頭。 )}]
[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 物件包含在請求主體中。
必填請求主體參數
常見問題
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,請向 `/v1/document-services/pdfs/encrypt` 端點發送包含 PDF 檔案的 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 檔案連同 POST 請求發送至 `/v1/document-services/pdfs/verify-password` 端點。請在請求中同時包含使用者密碼與擁有者密碼,以確認其有效性。
IronSecureDoc REST API 的主要功能有哪些?
IronSecureDoc REST API 的主要功能包括伺服器狀態檢查、授權驗證、文字遮蔽、數位簽章套用、PDF 加密以及文字擷取。





