1. IronSecureDoc
  2. 教程
  3. IronSecureDoc 的 REST API

C# 中 IronSecureDoc 的 REST API

Curtis Chau
Curtis Chau
已更新:
This article was translated from English: Does it need improvement?
Translated
View the article in English

这是您的 IronSecureDoc 实例的 REST API 参考文档。 本教程假设您已经有一个正在运行的容器实例。 如果您想开始使用，请按照我们的指南操作。

跳转至功能介绍：

检查许可证密钥

@@--BRACKET-t-OPEN--@

  • 所有示例中的 URL 将使用占位符http://localhost:8080/ 请务必将其替换为您的网址。
  • 请务必将占位符值（例如， path/to/your/file.pdf 、 证书密码等）替换为实际值。
  • 所有请求示例中都包含作者 、 标题和主题标头。 @@--bracket-close--@@@

[GET] 健康检查

端点： 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文件对象的形式包含 PDF 文件。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 需要编辑的PDF文件。
待编辑的文字 array[字符串] 需要从文档中删除的词语数组。

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。
特定页面 array[int] $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 您可以选择指定要应用的页面。如果留空，则应用所有页面。
绘制黑盒 布尔值 真的 在已涂黑的文本区域上绘制黑框。
匹配整个单词 布尔值 真的 允许对单词中的部分匹配项进行编辑。
区分大小写 布尔值 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 请区分要删除词语的大小写。
叠加文本 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 如果您希望在编辑区域上显示文字或符号等叠加文本，请在此处设置。如果未设置，则将使用空白字符。
保存为pdf 布尔值 错误的 保存符合 PDF/A-3 标准的 PDF 文件。
保存为pdfua 布尔值 错误的 保存符合 PDF/UA 规范的 PDF 文件。

可选标题

名称 数据类型 说明
作者 字符串 设置PDF元数据作者属性。
标题 字符串 设置PDF元数据标题属性。
主题 字符串 设置PDF元数据主题属性。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '待编辑的文字=pdf' \
  -F '绘制黑盒=true' \
  -F '匹配整个单词=true' \
  -F '区分大小写=true' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '待编辑的文字=pdf' \
  -F '绘制黑盒=true' \
  -F '匹配整个单词=true' \
  -F '区分大小写=true' \
SHELL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '待编辑的文字=word1' \
  -F '待编辑的文字=word2' \
  -F '绘制黑盒=true' \
  -F '匹配整个单词=true' \
  -F '区分大小写=true' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '叠加文本=REDACTED' \
  -F '特定页面=0' \
  -F '特定页面=1' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '待编辑的文字=word1' \
  -F '待编辑的文字=word2' \
  -F '绘制黑盒=true' \
  -F '匹配整个单词=true' \
  -F '区分大小写=true' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '叠加文本=REDACTED' \
  -F '特定页面=0' \
  -F '特定页面=1' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
SHELL

Response:

  • 200 OK，已附上编辑后的 PDF 文件。

[POST] 涂抹正则表达式

端点： http://localhost:8080/v1/document-services/pdfs/redact-regular-expression

使用真正的编辑技术，在 PDF 格式文档中隐藏敏感的正则表达式匹配项（例如日期、名称或模式）。 在请求正文中以pdf文件对象的形式包含 PDF 文件。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 需要编辑的PDF文件。
正则表达式 字符串 将从文档中删除与匹配项对应的正则表达式。

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。
特定页面 array[int] $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 您可以选择指定要应用的页面。如果留空，则应用所有页面。
绘制黑盒 布尔值 真的 在已涂黑的文本区域上绘制黑框。
叠加文本 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 如果您希望在编辑区域上显示文字或符号等叠加文本，请在此处设置。如果未设置，则将使用空白字符。
保存为pdf 布尔值 错误的 保存符合 PDF/A-3 标准的 PDF 文件。
保存为pdfua 布尔值 错误的 保存符合 PDF/UA 规范的 PDF 文件。

可选标题

名称 数据类型 说明
作者 字符串 设置PDF元数据作者属性。
标题 字符串 设置PDF元数据标题属性。
主题 字符串 设置PDF元数据主题属性。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '正则表达式="[0-9]"' \
  -F '绘制黑盒=true' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '正则表达式="[0-9]"' \
  -F '绘制黑盒=true' \
SHELL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '正则表达式="[0-9]"' \
  -F '绘制黑盒=true' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '叠加文本=*' \
  -F '特定页面=0' \
  -F '特定页面=1' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '正则表达式="[0-9]"' \
  -F '绘制黑盒=true' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '叠加文本=*' \
  -F '特定页面=0' \
  -F '特定页面=1' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
SHELL

Response:

  • 200 OK，已附上编辑后的 PDF 文件。

【帖子】编辑区域

端点： http://localhost:8080/v1/document-services/pdfs/redact-region

使用真正的密文技术，隐藏PDF文档特定区域中的敏感文本。 在请求正文中以pdf文件对象的形式包含 PDF 文件。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 需要编辑的PDF文件。
region_to_redact_x float 从页面左下角开始，确定要编辑区域的 X 坐标。
region_to_redact_y float 从页面左下角开始，要编辑区域的 Y 坐标。
region_to_redact_w float 从指定的 X 坐标开始，要编辑区域的宽度。
region_to_redact_h float 从指定的 Y 坐标开始，要编辑区域的高度。

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。
特定页面 array[int] $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 您可以选择指定要应用的页面。如果留空，则应用所有页面。
绘制黑盒 布尔值 真的 在已涂黑的文本区域上绘制黑框。
保存为pdf 布尔值 错误的 保存符合 PDF/A-3 标准的 PDF 文件。
保存为pdfua 布尔值 错误的 保存符合 PDF/UA 规范的 PDF 文件。

可选标题

名称 数据类型 说明
作者 字符串 设置PDF元数据作者属性。
标题 字符串 设置PDF元数据标题属性。
主题 字符串 设置PDF元数据主题属性。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
SHELL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -F '特定页面=0' \
  -F '特定页面=1' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F 'region_to_redact_x=100' \
  -F 'region_to_redact_y=150' \
  -F 'region_to_redact_w=500' \
  -F 'region_to_redact_h=400' \
  -F '特定页面=0' \
  -F '特定页面=1' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
SHELL

Response:

  • 200 OK，已附上编辑后的 PDF 文件。

[POST] 认证 / 应用数字签名

端点： http://localhost:8080/v1/document-services/pdfs/certify

通过证书文件（.p12、.pfx）向 PDF 文档添加认证，以证明该文档未被篡改。 在请求正文中包含一个 PDF 文件作为 pdf文件 对象，以及一个证书文件作为 证书文件 对象。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 待认证的PDF文件。
证书文件 application/x-pkcs12 文件 用于认证的证书文件（.p12、.pfx）。
证书密码 字符串 所提供证书文件的密码。
证书权限 int
证书权限值 权限
1 不允许任何更改。任何进一步的文件更改都将导致签名无效。
2 仅允许添加签名和填写表格。
3 仅允许添加签名、填写表格和添加注释

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。
保存为pdf 布尔值 错误的 保存符合 PDF/A-3 标准的 PDF 文件。
保存为pdfua 布尔值 错误的 保存符合 PDF/UA 规范的 PDF 文件。

可选标题

名称 数据类型 说明
作者 字符串 设置PDF元数据作者属性。
标题 字符串 设置PDF元数据标题属性。
主题 字符串 设置PDF元数据主题属性。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
SHELL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
SHELL

Response:

  • 200 OK，已附上认证的 PDF 文件。

【帖子】签名并附上证书

端点： http://localhost:8080/v1/document-services/pdfs/sign

通过证书文件（.p12、.pfx）向 PDF 文档中的图像添加图像和证书，以证明该图像未被篡改。 在请求正文中包含一个 PDF 文件作为 pdf文件 对象，以及一个证书文件作为 证书文件 对象。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 待认证的PDF文件。
签名图像文件 图像/jpeg 或图像/png 文件 用于认证的签名图片（.png、.jpg、.jpeg 格式）。可以是徽标、签名等。
证书文件 application/x-pkcs12 文件 用于认证的证书文件（.p12、.pfx）。
证书密码 字符串 所提供证书文件的密码。
证书权限 int
证书权限值 权限
1 不允许任何更改。任何进一步的文件更改都将导致签名无效。
2 仅允许添加签名和填写表格。
3 仅允许添加签名、填写表格和添加注释

特定页面 int 指定要应用图像和证书的页面。首页为 0。如果留空，则仅应用首页。
签名图像_x float 签名图像中矩形区域的 X 坐标。该坐标从页面左上角开始计算。
signature_image_y float 签名图像中矩形区域的 Y 坐标。该坐标从页面左上角开始计算。
签名图像_w float 签名图像矩形区域的宽度。该宽度从页面左上角开始计算。
签名图像_h float 签名图像矩形区域的高度。该高度从页面左上角开始计算。

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。
特定页面 array[int] $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 您可以选择指定要应用的页面。如果留空，则应用所有页面。
保存为pdf 布尔值 错误的 保存符合 PDF/A-3 标准的 PDF 文件。
保存为pdfua 布尔值 错误的 保存符合 PDF/UA 规范的 PDF 文件。

可选标题

名称 数据类型 说明
作者 字符串 设置PDF元数据作者属性。
标题 字符串 设置PDF元数据标题属性。
主题 字符串 设置PDF元数据主题属性。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '签名图像文件=@autograph.png;type=image/png' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
  -F '特定页面=0' \
  -F '签名图像_x=100' \
  -F 'signature_image_y=150' \
  -F '签名图像_w=500' \
  -F '签名图像_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '签名图像文件=@autograph.png;type=image/png' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
  -F '特定页面=0' \
  -F '签名图像_x=100' \
  -F 'signature_image_y=150' \
  -F '签名图像_w=500' \
  -F '签名图像_h=400' \
SHELL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '签名图像文件=@autograph.png;type=image/png' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
  -F '特定页面=0' \
  -F '签名图像_x=100' \
  -F 'signature_image_y=150' \
  -F '签名图像_w=500' \
  -F '签名图像_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '签名图像文件=@autograph.png;type=image/png' \
  -F '证书文件=@sample.pfx;type=application/x-pkcs12' \
  -F '证书密码=p4ssw0rd' \
  -F '证书权限=1' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
  -F '特定页面=0' \
  -F '签名图像_x=100' \
  -F 'signature_image_y=150' \
  -F '签名图像_w=500' \
  -F '签名图像_h=400' \
SHELL

Response:

  • 200 OK，已附上认证的 PDF 文件。

[POST] 验证签名

端点： http://localhost:8080/v1/document-services/pdfs/verify-signatures

验证 PDF 文件中的签名是否有效。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 待加密的PDF文件。

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。

例子：

Request

仅需提供参数：

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
YAML

所有必填和可选参数：

curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
YAML

Response:

  • 200 如果签名齐全且全部有效，则没问题
  • 如果没有签名或至少一个签名无效，则返回 400 Bad Request 错误。

[POST] 加密/添加密码和权限

端点： http://localhost:8080/v1/document-services/pdfs/encrypt

使用用户密码和所有者密码对 PDF 文档进行加密，从而为 PDF 文档增加一层安全保障。 在请求正文中以pdf文件对象的形式包含 PDF 文件。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 待加密的PDF文件。
允许提取内容 布尔值 允许从PDF文件中提取内容。
允许表单填写 布尔值 允许在生成的 PDF 文件中填写表格。
允许注解 布尔值 允许在生成的 PDF 文件中添加或修改注释。
允许打印 布尔值 允许打印生成的PDF文件。
允许修改 布尔值 允许对生成的PDF文件进行修改。
新所有者密码 字符串 为输出 PDF 文件设置新的所有者密码。授予完全访问权限，包括更改权限和密码。

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。
新用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 为输出 PDF 文件设置新的用户密码。授予读取权限和其他指定权限。
保存为pdf 布尔值 错误的 保存符合 PDF/A-3 标准的 PDF 文件。
保存为pdfua 布尔值 错误的 保存符合 PDF/UA 规范的 PDF 文件。

可选标题

名称 数据类型 说明
作者 字符串 设置PDF元数据作者属性。
标题 字符串 设置PDF元数据标题属性。
主题 字符串 设置PDF元数据主题属性。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '允许提取内容=true' \
  -F '允许表单填写=true' \
  -F '允许注解=true' \
  -F '允许打印=true' \
  -F '允许修改=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '允许提取内容=true' \
  -F '允许表单填写=true' \
  -F '允许注解=true' \
  -F '允许打印=true' \
  -F '允许修改=false' \
SHELL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '允许提取内容=true' \
  -F '允许表单填写=true' \
  -F '允许注解=true' \
  -F '允许打印=true' \
  -F '允许修改=false' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '新用户密码=p4ssw0rd' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '允许提取内容=true' \
  -F '允许表单填写=true' \
  -F '允许注解=true' \
  -F '允许打印=true' \
  -F '允许修改=false' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '新用户密码=p4ssw0rd' \
  -F '保存为pdf=false' \
  -F '保存为pdfua=false' \
SHELL

Response:

  • 200 OK，已附加加密的 PDF 文件。

[帖子] 从文档中提取文本

端点： http://localhost:8080/v1/document-services/pdfs/extract

提取嵌入在文档页面中的文本。 在请求正文中以pdf文件对象的形式包含 PDF 文件。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 待加密的PDF文件。

可选的请求体参数

名称 数据类型 默认 说明
用户密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 输入 PDF 文件的所有者密码。如果 PDF 文件设有所有者密码，则需要此密码才能授予访问权限进行修改。
特定页面 array[int] $10,998 $8,999 覆盖隔离开发 + OEM。需要更多选项？考虑 Enterprise 您可以选择指定要应用的页面。如果留空，则应用所有页面。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
SHELL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '特定页面=0' \
  -F '特定页面=1' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
  -F '特定页面=0' \
  -F '特定页面=1' \
SHELL

Response:

  • 200 OK，以提取的文本作为响应。

[POST] 验证文档密码

端点： http://localhost:8080/v1/document-services/pdfs/verify-password

验证提供的用户密码和所有者密码对pdf文件是否有效。

所需请求正文参数

名称 数据类型 说明
pdf文件 应用程序/pdf文件 PDF文件。
用户密码 字符串 输入 PDF 的用户密码。如果 PDF 文件需要用户密码才能授予读取权限，则必须输入此密码。
所有者密码 字符串 输入PDF文件的所有者密码。

例子：

Request

仅需提供参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/verify-password' \
  -H 'accept: */*' \
  -H '作者: Iron Software | IRONSECUREDOC' \
  -H '标题: WEBSITE DEMO 2024' \
  -H '主题: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf文件=@sample.pdf;type=application/pdf' \
  -F '用户密码=password' \
  -F '所有者密码=5yug2RT45th32h78' \
SHELL

Response:

  • 200 OK

常见问题解答

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` 端点发送包含 PDF 和要编辑的文本或正则表达式的 POST 请求，来编辑特定文本或模式。

如何验证 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` 端点发送包含 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
Curtis Chau
  立即与工程团队聊天
技术作家

Curtis Chau 拥有卡尔顿大学的计算机科学学士学位，专注于前端开发，精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面，喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。

除了开发之外，Curtis 对物联网 (IoT) 有浓厚的兴趣，探索将硬件和软件集成的新方法。在空闲时间，他喜欢玩游戏和构建 Discord 机器人，将他对技术的热爱与创造力相结合。

准备开始了吗？
Version: 2024.10 刚刚发布