REST API for IronSecureDoc in C#
这是您的 IronSecureDoc 实例的 REST API 参考文档。 本教程假设您已经有一个正在运行的容器实例。 如果您想开始使用，请按照我们的指南操作。
跳转至功能介绍：
- PDF编辑功能 -编辑文本 -编辑正则表达式 -编辑区域
- PDF签名功能 -认证 PDF / 应用数字签名 -签署PDF/应用签名图像 -验证证书/签名
- 保护 PDF 功能 -对PDF文件进行加密/添加密码 -设置PDF权限 -验证密码
- 所有示例中的 URL 将使用
http://localhost:8080/占位符。 请务必将其替换为您的网址。 - 确保用实际值替换占位符值(例如，
certificate_password等)。 - 所有请求示例中均包含
title和subject标头。 )}]
[GET] 健康检查
端点： http://localhost:8080/v1/document-services/ping
健康检查端点，用于验证服务器是否正在运行。
响应： 200 OK：pong
[GET] 检查许可证
端点： http://localhost:8080/v1/document-services/check-license
验证许可证的有效性。
响应： 200 OK：Valid
[POST] 涂改文本
端点： http://localhost:8080/v1/document-services/pdfs/redact-text
使用真正的密文技术隐藏PDF文档中的敏感词语。 在请求正文中将 PDF 文件包含为 pdf_file 对象。
所需请求正文参数
常见问题解答
IronSecureDoc REST API 的目的是什么？
IronSecureDoc REST API 旨在通过提供文本编辑、数字签名应用、文档加密和密码验证等功能，帮助开发人员保护和管理 PDF 文档。
using IronSecureDoc API 如何确保服务器正常运行？
您可以通过向 `/v1/document-services/ping` 端点发送 GET 请求来确保服务器正常运行。如果成功，服务器将以 `200 OK` 状态和消息 `pong` 响应。
如何使用 API 在 PDF 中编辑特定文本或模式？
您可以通过向 `/v1/document-services/pdfs/redact-text` 端点发送包含 PDF 和要编辑的文本或正则表达式的 POST 请求，来编辑特定文本或模式。
如何验证 PDF 的数字签名是否有效？
要验证 PDF 中的数字签名，您可以发送包含 PDF 文件的 POST 请求到 `/v1/document-services/pdfs/verify-signatures` 端点。该 API 将返回每个签名的有效性信息。
using IronSecureDoc API 加密 PDF 包含哪些步骤？
要加密 PDF，请向 `/v1/document-services/pdfs/encrypt` 端点发送包含 PDF 文件的 POST 请求，指定用户和所有者密码以及您希望设置的任何权限，例如内容提取或表单填写。
如何使用 IronSecureDoc API 对 PDF 文档进行数字签名？
您可以通过向 `/v1/document-services/pdfs/certify` 端点发送包含 PDF 文件、数字证书和证书密码的 POST 请求来对 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 加密和文本提取。
Curtis Chau 拥有卡尔顿大学的计算机科学学士学位，专注于前端开发，精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面，喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。
