如何在 .NET 中使用 C# 呼叫 IronSecureDoc

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

通往增強文件安全性的門戶

Iron Software.SecureDoc.Client 是一個強大的用戶端函式庫,設計用來與 IronSecureDoc API 進行無縫互動,IronSecureDoc API 是一個託管在 Docker 容器中的全面性文件安全解決方案。

此客戶端程式庫可輕鬆整合到您現有的 .NET 應用程式中,使您能夠利用 IronSecureDoc 的強大功能,包括 PDF 加密、編輯和數位簽名,所有這些都可透過簡單的 REST API 呼叫實現。

透過 Iron Software.SecureDoc.Client,開發人員可確保應用程式內文件的安全性與完整性,並在現場維持所有作業,以加強資料保護。 無論您是需要刪除敏感資訊、使用數位簽章認證文件,或是強制執行文件加密,Iron Software.SecureDoc.Client 都能提供必要的工具,讓您有效且安全地完成這些任務。

特點

主要特點:

  • 可輕鬆與 IronSecureDoc 的 REST API 整合。
  • 支援文件加密、編輯和數位簽章。
  • 促進在自託管環境中進行安全文件處理。
  • 透過將文件安全操作保留在本地,增強資料保護。
  • 與 .NET 應用程式相容,提供了一種安全文件管理的簡單方法。

安裝

我們先從套件管理器安裝 NuGet 套件:

選項 1:從 NuGet 下載

NuGet 套件已列在 NuGet 官方網站上: https://www.nuget.org/packages/IronSoftware.SecureDoc.Client

選項 2:PM 安裝指令

Install-Package IronSoftware.SecureDoc.Client

程式碼範例

using IronSecureDoc;
using System.IO;
using System.Threading.Tasks;

// Example illustrating how to use the IronSecureDocClient
class SecureDocExample
{
    static async Task Main(string[] args)
    {
        // Replace with your IRONSECUREDOC URL
        var client = new IronSecureDocClient("http://localhost:5185");

        // Replace with your PDF or CERT paths
        string PDF_PATH = "path/to/your.pdf";
        string CERT_PATH = "path/to/your.p12";

        // Attempt to connect to the IronSecureDoc API
        if (await client.TryConnectAsync())
        {
            // Redact Text
            File.WriteAllBytes(
                "redact_text_example.pdf",
                await client.RedactTextAsync(PDF_PATH, new[] { "Dummy" })
            );

            // Redact Region
            File.WriteAllBytes(
                "redact_region_example.pdf",
                await client.RedactRegionAsync(PDF_PATH, 50, 50, 200, 100)
            );

            // Certify
            File.WriteAllBytes(
                "certify_example.pdf",
                await client.CertifyAsync(PDF_PATH, CERT_PATH, "123456", CertifyPermissions.FormFillingAllowed)
            );

            // Encrypt
            File.WriteAllBytes(
                "encrypt_example.pdf",
                await client.EncryptAsync(PDF_PATH, "iron")
            );
        }
    }
}
using IronSecureDoc;
using System.IO;
using System.Threading.Tasks;

// Example illustrating how to use the IronSecureDocClient
class SecureDocExample
{
    static async Task Main(string[] args)
    {
        // Replace with your IRONSECUREDOC URL
        var client = new IronSecureDocClient("http://localhost:5185");

        // Replace with your PDF or CERT paths
        string PDF_PATH = "path/to/your.pdf";
        string CERT_PATH = "path/to/your.p12";

        // Attempt to connect to the IronSecureDoc API
        if (await client.TryConnectAsync())
        {
            // Redact Text
            File.WriteAllBytes(
                "redact_text_example.pdf",
                await client.RedactTextAsync(PDF_PATH, new[] { "Dummy" })
            );

            // Redact Region
            File.WriteAllBytes(
                "redact_region_example.pdf",
                await client.RedactRegionAsync(PDF_PATH, 50, 50, 200, 100)
            );

            // Certify
            File.WriteAllBytes(
                "certify_example.pdf",
                await client.CertifyAsync(PDF_PATH, CERT_PATH, "123456", CertifyPermissions.FormFillingAllowed)
            );

            // Encrypt
            File.WriteAllBytes(
                "encrypt_example.pdf",
                await client.EncryptAsync(PDF_PATH, "iron")
            );
        }
    }
}
Imports IronSecureDoc
Imports System.IO
Imports System.Threading.Tasks

' Example illustrating how to use the IronSecureDocClient
Friend Class SecureDocExample
	Shared Async Function Main(ByVal args() As String) As Task
		' Replace with your IRONSECUREDOC URL
		Dim client = New IronSecureDocClient("http://localhost:5185")

		' Replace with your PDF or CERT paths
		Dim PDF_PATH As String = "path/to/your.pdf"
		Dim CERT_PATH As String = "path/to/your.p12"

		' Attempt to connect to the IronSecureDoc API
		If Await client.TryConnectAsync() Then
			' Redact Text
			File.WriteAllBytes("redact_text_example.pdf", Await client.RedactTextAsync(PDF_PATH, { "Dummy" }))

			' Redact Region
			File.WriteAllBytes("redact_region_example.pdf", Await client.RedactRegionAsync(PDF_PATH, 50, 50, 200, 100))

			' Certify
			File.WriteAllBytes("certify_example.pdf", Await client.CertifyAsync(PDF_PATH, CERT_PATH, "123456", CertifyPermissions.FormFillingAllowed))

			' Encrypt
			File.WriteAllBytes("encrypt_example.pdf", Await client.EncryptAsync(PDF_PATH, "iron"))
		End If
	End Function
End Class
$vbLabelText   $csharpLabel

說明

  • IronSecureDocClient 初始化:使用 IRONSECUREDOC 伺服器的 URL 初始化IronSecureDocClient 。 -連線:使用TryConnectAsync()驗證與伺服器的連線。 -編輯文字:使用RedactTextAsync定義要編輯的敏感字詞/片語。 -編輯區域:透過RedactRegionAsync指定座標來編輯特定區域。
  • Certify :使用CertifyAsync新增數位憑證。 請提供證書檔案的路徑和密碼。 -加密:使用EncryptAsync對文件進行加密,以保護文件安全。

支援

如需技術支持,請聯絡我們:support@ironsoftware.com

常見問題解答

如何將文檔安全功能整合到我的 .NET 應用程序中?

您可以通過使用 Iron Software.SecureDoc.Client 庫整合文檔安全功能。這樣可以通過 REST API 調用進行操作,如 PDF 加密、編輯和數字簽名。

在 C# 項目中安裝 IronSecureDoc 客戶端涉及哪些步驟?

要在 C# 項目中安裝 IronSecureDoc 客戶端,您可以從 NuGet 下載 Iron Software.SecureDoc.Client 包或使用包管理器命令:Install-Package Iron Software.SecureDoc.Client

我能夠使用這個解決方案進行 PDF 文檔的文本編輯嗎?

是的,您可以通過使用 RedactTextAsync 方法執行 PDF 文檔的文本編輯,該方法允許您指定要編輯的單詞或短語。

如何確保我的文檔操作保持安全並在現場?

使用 IronSecureDoc 通過集成 IronSecureDoc API 來保持文檔操作的安全性和現場進行,這是一種 Docker 托管的解決方案,確保所有安全操作均在本地處理。

IronSecureDoc API 提供什麼功能來進行文檔管理?

IronSecureDoc API 提供了文檔加密、編輯、數字簽名的功能,並促進自我託管環境內的安全文檔處理。

如何使用數字簽名認證 PDF 文件?

要使用數字簽名認證 PDF 文件,請使用 CertifyAsync 方法,提供您的認證文件的路徑和必要的密碼。

如何在我的 C# 應用程序中加密 PDF 文件?

您可以在 C# 應用程序中使用 EncryptAsync 方法加密 PDF 文件,該方法會使用指定的密碼保護文件。

在PDF文檔中是否可以遮蓋特定區域?

是的,可以通過使用 RedactRegionAsync 方法在 PDF 文件中編輯特定區域,該方法需要您指定要編輯區域的座標。

如果使用IronSecureDoc客戶端時遇到問題,我該怎麼辦?

如果您使用 IronSecureDoc 客戶端時遇到問題,您可以通過電子郵件 support@Iironsoftware.com 聯繫 Iron Software 的支持團隊以獲得幫助。

Curtis Chau
技術作家

Curtis Chau 擁有卡爾頓大學計算機科學學士學位,專注於前端開發,擅長於 Node.js、TypeScript、JavaScript 和 React。Curtis 熱衷於創建直觀且美觀的用戶界面,喜歡使用現代框架並打造結構良好、視覺吸引人的手冊。

除了開發之外,Curtis 對物聯網 (IoT) 有著濃厚的興趣,探索將硬體和軟體結合的創新方式。在閒暇時間,他喜愛遊戲並構建 Discord 機器人,結合科技與創意的樂趣。

準備好開始了嗎?
Version: 2024.10 剛發表