1. IronSecureDoc
  2. 教程
  3. Azure 主机和设置

IronSecureDoc 的 REST API

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

这是 IronSecureDoc 实例的 REST API 参考。本教程假定您已经运行了一个容器实例，如果您想 请按照我们的指南开始操作。

提示

  • 所有示例中的 URL 都将使用占位符 http://localhost:8080/。请确保将其替换为您的 URL。

  • 确保替换占位符值 (例如，"path/to/your/file.pdf"、"certificate_password "等。) 实际值。

  • 所有请求示例都包含 "作者"、"标题 "和 "主题 "标头。

[获取] 健康检查

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

必需的请求正文参数

名称 *数据类型* 描述**

pdf_file 应用程序/pdf 文件 要编辑的 PDF 文件。

要编辑的字词 数组[字符串]

要从文件中编辑的字词数组。

可选请求正文参数

名称 *数据类型* 默认 描述**

user_password 字符串 无效 输入 PDF 的用户密码。如果 PDF 有授予读取权限的用户密码，则为必填项。

所有者密码 字符串 空 输入 PDF 的所有者密码。如果 PDF 有所有者密码，则需要此密码才能访问进行修改。

特定页面 数组[int]

无效 可选择指定要应用的页面。如果留空，所有页面都将适用。

绘制黑框 bool 真 在编辑文本区域绘制黑框。

匹配全词 bool 真 允许也编辑词内的部分匹配。

匹配大小写 bool 空 匹配要编辑的单词的大小写。

overlay_text 字符串 空 如果您希望在编辑区域设置文字或符号等覆盖文本，请在此处设置。如果未设置，将使用空白字符。

另存为 bool 假 保存符合 PDF/A-3 标准的 PDF 文件。

保存为 PDFua bool 假 保存符合 PDF/UA 标准的 PDF 文件。

可选标头

名称 *数据类型* 描述**

作者 字符串 设置 PDF 元数据作者属性

标题 字符串 设置 PDF 元数据标题属性。

主题 字符串 设置 PDF 元数据主题属性。

示例：

请求

仅为必填参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="pdf"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
CURL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'words_to_redact="word1"' \
  -F 'words_to_redact="word2"' \
  -F 'draw_black_box=true' \
  -F 'match_whole_word=true' \
  -F 'match_case=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="REDACTED"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

答复：

  • 200 OK，附带经过编辑的 PDF 文件。

[职位] 重制正则表达式

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

隐藏敏感的正则表达式匹配 (如日期、名称或图案) 在 PDF 格式文件中使用真正的编辑。在请求正文中以 pdf_file 对象的形式包含 PDF 文件。

必需的请求正文参数

名称 *数据类型* 描述**

pdf_file 应用程序/pdf 文件 要编辑的 PDF 文件。

正则表达式 字符串 正则表达式，从中匹配的情况将从文件中编辑。

可选请求正文参数

名称 *数据类型* 默认 描述**

user_password 字符串 无效 输入 PDF 的用户密码。如果 PDF 有授予读取权限的用户密码，则为必填项。

所有者密码 字符串 空 输入 PDF 的所有者密码。如果 PDF 有所有者密码，则需要此密码才能访问进行修改。

特定页面 数组[int]

无效 可选择指定要应用的页面。如果留空，所有页面都将适用。

绘制黑框 bool 真 在编辑文本区域绘制黑框。

覆盖文本 字符串 空 如果您希望在编辑区域覆盖文字（如单词或符号），请在此处设置。如果未设置，将使用空白字符。

另存为 bool 假 保存符合 PDF/A-3 标准的 PDF 文件。

保存为 PDFua bool 假 保存符合 PDF/UA 标准的 PDF 文件。

可选标头

名称 *数据类型* 描述**

作者 字符串 设置 PDF 元数据作者属性

标题 字符串 设置 PDF 元数据标题属性。

主题 字符串 设置 PDF 元数据主题属性。

示例：

请求

仅为必填参数：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
CURL

所有必填和可选参数：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'regular_expression="[0-9]"' \
  -F 'draw_black_box=true' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'overlay_text="%2A"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

答复：

  • 200 OK，附带经过编辑的 PDF 文件。

[职位] 地区

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

描述：使用真正的编辑功能隐藏 PDF 文档特定区域中的敏感文本。在请求正文中以 pdf_file 对象的形式包含 PDF 文件。

必需的请求正文参数

名称 *数据类型* 描述**

pdf_file 应用程序/pdf 文件 要编辑的 PDF 文件。

区域 浮动 要编辑区域的 X 坐标，从页面左下方开始。

要删除的区域的 y 坐标 浮点 要编辑区域的 Y 坐标，从页面左下方开始。

要编辑的区域 浮点 要编辑区域的宽度，从指定的 X 坐标开始。

要删除的区域宽度 浮点数 要删除区域的高度，从指定的 Y 坐标开始。

可选请求正文参数

名称 *数据类型* 默认 描述**

user_password 字符串 无效 输入 PDF 的用户密码。如果 PDF 有授予读取权限的用户密码，则为必填项。

所有者密码 字符串 空 输入 PDF 的所有者密码。如果 PDF 有所有者密码，则需要此密码才能访问进行修改。

特定页面 数组[int]

无效 可选择指定要应用的页面。如果留空，所有页面都将适用。

绘制黑框 bool 为真 在编辑文本区域绘制黑框。

save_as_pdfa bool 假 保存符合 PDF/A-3 标准的 PDF 文件。

保存为 PDFua bool 假 保存符合 PDF/UA 标准的 PDF 文件。

可选标头

名称 *数据类型* 描述**

作者 字符串 设置 PDF 元数据作者属性

标题 字符串 设置 PDF 元数据标题属性。

主题 字符串 设置 PDF 元数据主题属性。

示例：

请求

仅为必填参数：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@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

所有必填和可选参数：

curl -X 'POST' \
  'http://localhost:8080/v1/document-services/pdfs/redact-region' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="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 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

答复：

  • 200 OK，附带经过编辑的 PDF 文件。

[职位] 认证/应用数字签名

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

`

描述：通过证书文件为 PDF 文档添加认证，以确保文档未被篡改 (.p12, .pfx).将 PDF 文件作为 pdf_file 对象包含在请求正文中，将证书文件作为 certificate_file 对象包含在请求正文中。

必需的请求正文参数

名称 *数据类型* 描述**

pdf_file 应用程序/pdf 文件 要认证的 PDF 文件。

证书文件 应用程序/x-pkcs12 文件 证书文件 (.p12, .pfx) 用于认证。

证书密码 字符串 所提供证书文件的密码。

证书权限 int 证书的权限类型：0 :默认，1 : 允许填写表格，2 : 允许填写表格和注释，3 : 不允许更改

可选请求正文参数

名称 *数据类型* 默认 描述**

user_password 字符串 无效 输入 PDF 的用户密码。如果 PDF 有授予读取权限的用户密码，则为必填项。

所有者密码 字符串 空 输入 PDF 的所有者密码。如果 PDF 有所有者密码，则需要此密码才能访问进行修改。

特定页面 数组[int]

无效 可选择指定要应用的页面。如果留空，所有页面都将适用。

save_as_pdfa bool 假 保存符合 PDF/A-3 标准的 PDF。

保存为 PDFua bool 假 保存符合 PDF/UA 标准的 PDF 文件。

可选标头

名称 *数据类型* 描述**

作者 字符串 设置 PDF 元数据作者属性

标题 字符串 设置 PDF 元数据标题属性。

主题 字符串 设置 PDF 元数据主题属性。

示例：

请求

仅为必填参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
CURL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/certify' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
  -F 'certificate_password="p4ssw0rd"' \
  -F 'certificate_permissions=0' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

答复：

  • 200 OK，附带经认证的 PDF 文件。

[职位] 加密/添加密码和权限

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

描述：使用用户和所有者密码对 PDF 文档进行加密，从而为 PDF 文档添加一层安全保护。将 PDF 文件作为 pdf_file 对象包含在请求正文中。

必需的请求正文参数

名称 *数据类型* 描述**

pdf_file 应用程序/PDF 文件 要加密的 PDF 文件。

允许提取内容 bool 允许从 PDF 文件中提取内容。

允许填充表格 bool 允许在生成的 PDF 文件中填写表格。

允许注释 bool 允许在生成的 PDF 中添加或修改注释。

允许打印 bool 允许打印生成的 PDF。

允许修改 bool 允许修改生成的 PDF。

new_owner_password 字符串 输出 PDF 的新所有者密码。授予完全访问权限，包括更改权限和密码。

可选请求正文参数

名称 *数据类型* 默认 描述**

user_password 字符串 无效 输入 PDF 的用户密码。如果 PDF 有授予读取权限的用户密码，则为必填项。

所有者密码 字符串 空 输入 PDF 的所有者密码。如果 PDF 有所有者密码，则需要此密码才能访问进行修改。

新用户密码 字符串 空 输出 PDF 的新用户密码。授予读取权限和其他指定权限。

save_as_pdfa bool 假 保存符合 PDF/A-3 标准的 PDF 文件。

保存为 PDFua bool 假 保存符合 PDF/UA 标准的 PDF 文件。

可选标头

名称 *数据类型* 描述**

作者 字符串 设置 PDF 元数据作者属性

标题 字符串 设置 PDF 元数据标题属性。

主题 字符串 设置 PDF 元数据主题属性。

示例：

请求

仅为必填参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
CURL

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/encrypt' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'allow_extracting_content=true' \
  -F 'allow_form_filling=true' \
  -F 'allow_annotations=true' \
  -F 'allow_printing=true' \
  -F 'allow_modifications=false' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'new_user_password="p4ssw0rd"' \
  -F 'save_as_pdfa=false' \
  -F 'save_as_pdfua=false' \
CURL

答复：

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

[职位] 从文档中提取文本

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

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

必需的请求正文参数

名称 *数据类型* 描述**

pdf_file 应用程序/PDF 文件 要加密的 PDF 文件。

可选请求正文参数

名称 *数据类型* 默认 描述**

user_password 字符串 无效 输入 PDF 的用户密码。如果 PDF 有授予读取权限的用户密码，则为必填项。

所有者密码 字符串 空 输入 PDF 的所有者密码。如果 PDF 有所有者密码，则需要此密码才能访问进行修改。

特定页面 数组[int]

无效 可选择指定要应用的页面。如果留空，所有页面都将适用。

示例：

请求

仅为必填参数：

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

所有必填和可选参数：

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/extract' \
  -H 'accept: */*' \
  -H 'author: Iron Software 
 IRONSECUREDOC' \
  -H 'title: WEBSITE DEMO 2024' \
  -H 'subject: DEMO EXAMPLE' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@sample.pdf;type=application/pdf' \
  -F 'user_password="password"' \
  -F 'owner_password="5yug2RT45th32h78"' \
  -F 'specific_pages=0' \
  -F 'specific_pages=1' \
CURL

答复：

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