[获取] 健康检查
终端: http://localhost:8080/v1/document-services/ping
用于验证服务器运行状况的健康检查端点。
响应: 200 OK: pong
[获取] 检查许可证
端点: http://localhost:8080/v1/document-services/check-license
验证许可证的有效性。
响应:200 OK: 有效
[职位] 编辑文本
端点: http://localhost:8080/v1/document-services/pdfs/redact-text
使用真正的编辑功能隐藏PDF格式文档中的敏感词。 在请求正文中包含一个PDF文件作为pdf_file
对象。
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 要编辑的PDF文件。 |
words_to_redact | 数组[string] | 需从文档中删除的词汇数组。 |
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
specific_pages | 数组[int] | 空 | 可选地指定要应用的页面。如果留空,则适用于所有页面。 |
draw_black_box | bool | 正确 | 在修订文本区域上绘制一个黑色框。 |
完全匹配单词 | bool | 正确 | 允许部分匹配的词语也被编辑。 |
匹配大小写 | bool | 空 | 匹配要编辑的单词的大小写。 |
覆盖文本 | 字符串 | 空 | 如果您希望在编辑区域上覆盖文本,例如单词或符号,请在此处设置。如果未设置,将使用空白字符。 |
save_as_pdfa | bool | 假的 | 将 PDF 保存为符合 PDF/A-3 的格式。 |
保存为PDF/UA | bool | 假的 | 保存 PDF 并符合 PDF/UA 规范。 |
可选标题
名字 | 数据类型 | 说明 |
---|
作者 | 字符串 | 设置 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 -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 -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
响应:
[职位] 涂抹正则表达式
Endpoint: http://localhost:8080/v1/document-services/pdfs/redact-regular-expression
隐藏敏感的正则表达式匹配(如日期、名称或图案)在 PDF 格式的文档中使用真正的编辑。 在请求正文中包含一个PDF文件作为pdf_file
对象。
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 要编辑的PDF文件。 |
正则表达式 | 字符串 | 将从文档中编辑掉匹配案例的正则表达式。 |
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
specific_pages | 数组[int] | 空 | 可选地指定要应用的页面。如果留空,则适用于所有页面。 |
draw_black_box | bool | 正确 | 在修订文本区域上绘制一个黑色框。 |
覆盖文本 | 字符串 | 空 | 如果您希望在编辑区域上覆盖文本,例如单词或符号,请在此处设置。如果未设置,将使用空白字符。 |
save_as_pdfa | bool | 假的 | 将 PDF 保存为符合 PDF/A-3 的格式。 |
保存为PDF/UA | bool | 假的 | 保存 PDF 并符合 PDF/UA 规范。 |
可选标题
名字 | 数据类型 | 说明 |
---|
作者 | 字符串 | 设置 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 -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 -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
响应:
[职位] 编辑区域
端点: http://localhost:8080/v1/document-services/pdfs/redact-region
描述:使用真正的删除隐藏 PDF 文档特定区域中的敏感文本。 在请求正文中包含一个PDF文件作为pdf_file
对象。
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 要编辑的PDF文件。 |
region_to_redact_x | 浮动 | 要涂黑区域的 X 坐标,从页面的左下角开始。 |
区域_待编辑_y | 浮动 | 要涂黑的区域的 Y 坐标,从页面的左下角开始。 |
region_to_redact_w | 浮动 | 从指定的 X 坐标开始的要涂黑区域的宽度。 |
region_to_redact_h | 浮动 | 从指定的 Y 坐标开始,待编辑区域的高度。 |
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
specific_pages | 数组[int] | 空 | 可选地指定要应用的页面。如果留空,则适用于所有页面。 |
draw_black_box | bool | 正确 | 在修订文本区域上绘制一个黑色框。 |
save_as_pdfa | bool | 假的 | 将 PDF 保存为符合 PDF/A-3 的格式。 |
保存为PDF/UA | bool | 假的 | 保存 PDF 并符合 PDF/UA 规范。 |
可选标题
名字 | 数据类型 | 说明 |
---|
作者 | 字符串 | 设置 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 -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 -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
响应:
[职位] 认证/应用数字签名
端点: http://localhost:8080/v1/document-services/pdfs/certify
描述:通过证书文件向PDF文档添加认证,以确认它未被篡改。(.p12, .pfx). 在请求体中包含一个作为pdf_file
对象的PDF文件,以及一个作为certificate_file
对象的证书文件。
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 需要认证的PDF文件。 |
证书文件 | application/x-pkcs12 文件 | 用于认证的证书文件(.p12,.pfx)。 |
证书密码 | 字符串 | 提供的证书文件的密码。 |
证书权限 | int | certificate_permissions 值 | 权限 |
---|
| 不允许更改。任何进一步的文件更改将使签名无效。 | | 仅允许附加签名和填写表单。 | | 仅允许附加签名、表单填写和注释 |
|
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
save_as_pdfa | bool | 假的 | 将 PDF 保存为符合 PDF/A-3 的格式。 |
保存为PDF/UA | bool | 假的 | 保存 PDF 并符合 PDF/UA 规范。 |
可选标题
名字 | 数据类型 | 说明 |
---|
作者 | 字符串 | 设置 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=1' \
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=1' \
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=1' \
-F 'user_password="password"' \
-F 'owner_password="5yug2RT45th32h78"' \
-F 'save_as_pdfa=false' \
-F 'save_as_pdfua=false' \
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=1' \
-F 'user_password="password"' \
-F 'owner_password="5yug2RT45th32h78"' \
-F 'save_as_pdfa=false' \
-F 'save_as_pdfua=false' \
CURL
响应:
[职位] 使用签名和证书进行签署
端点: http://localhost:8080/v1/document-services/pdfs/sign
描述:在PDF文档中添加图片和认证,以通过证书文件断言该图片未被篡改。(.p12, .pfx). 在请求体中包含一个作为pdf_file
对象的PDF文件,以及一个作为certificate_file
对象的证书文件。
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 需要认证的PDF文件。 |
签名图像文件 | 图像/jpeg或图像/png文件 | 用于认证的签名图像(.png、.jpg、.jpeg)。可以是徽标、亲笔签名等。 |
证书文件 | application/x-pkcs12 文件 | 用于认证的证书文件(.p12,.pfx)。 |
证书密码 | 字符串 | 提供的证书文件的密码。 |
证书权限 | int | certificate_permissions 值 | 权限 |
---|
| 不允许更改。任何进一步的文件更改将使签名无效。 | | 仅允许附加签名和填写表单。 | | 仅允许附加签名、表单填写和注释 |
|
指定页面签名 | int | 指定要将图像和证书应用到的页面。第一页为0。如果留空,则仅应用于第一页。 |
signature_image_x | 浮动 | 签名图像矩形区域的 X 坐标。这个坐标从页面的左上角开始。 |
签名图像_y | 浮动 | 签名图像矩形区域的Y坐标,从页面的左上角开始。 |
签名_图像_w | 浮动 | 签名图像矩形区域的宽度。从页面的左上角开始。 |
签名_图像_h | 浮动 | 签名图像矩形区域的高度。其起点在页面的左上角。 |
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
specific_pages | 数组[int] | 空 | 可选地指定要应用的页面。如果留空,则适用于所有页面。 |
save_as_pdfa | bool | 假的 | 将 PDF 保存为符合 PDF/A-3 的格式。 |
保存为PDF/UA | bool | 假的 | 保存 PDF 并符合 PDF/UA 规范。 |
可选标题
名字 | 数据类型 | 说明 |
---|
作者 | 字符串 | 设置 PDF 元数据作者属性。 |
标题 | 字符串 | 设置PDF元数据标题属性。 |
主题 | 字符串 | 设置PDF元数据的主题属性。 |
示例:
请求
仅为必填参数:
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
-H 'accept: */*' \
-H 'Content-Type: multipart/form-data' \
-F 'pdf_file=@sample.pdf;type=application/pdf' \
-F 'signature_image_file=@autograph.png;type=image/png' \
-F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
-F 'certificate_password="p4ssw0rd"' \
-F 'certificate_permissions=1' \
-F 'sign_specific_page=0' \
-F 'signature_image_x=100' \
-F 'signature_image_y=150' \
-F 'signature_image_w=500' \
-F 'signature_image_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
-H 'accept: */*' \
-H 'Content-Type: multipart/form-data' \
-F 'pdf_file=@sample.pdf;type=application/pdf' \
-F 'signature_image_file=@autograph.png;type=image/png' \
-F 'certificate_file=@sample.pfx;type=application/x-pkcs12' \
-F 'certificate_password="p4ssw0rd"' \
-F 'certificate_permissions=1' \
-F 'sign_specific_page=0' \
-F 'signature_image_x=100' \
-F 'signature_image_y=150' \
-F 'signature_image_w=500' \
-F 'signature_image_h=400' \
CURL
所有必填和可选参数:
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
-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 'save_as_pdfa=false' \
-F 'save_as_pdfua=false' \
-F 'sign_specific_page=0' \
-F 'signature_image_x=100' \
-F 'signature_image_y=150' \
-F 'signature_image_w=500' \
-F 'signature_image_h=400' \
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/sign' \
-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 'save_as_pdfa=false' \
-F 'save_as_pdfua=false' \
-F 'sign_specific_page=0' \
-F 'signature_image_x=100' \
-F 'signature_image_y=150' \
-F 'signature_image_w=500' \
-F 'signature_image_h=400' \
CURL
响应:
[职位] 验证签名
Endpoint: http://localhost:8080/v1/document-services/pdfs/verify-signatures
描述:验证提供的用户密码和所有者密码是否对 pdf_file
有效
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 要加密的PDF文件。 |
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
示例:
请求
仅为必填参数:
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
-H 'accept: */*' \
-H 'Content-Type: multipart/form-data' \
-F 'pdf_file=@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_file=@sample.pdf;type=application/pdf' \
YAML
所有必填和可选参数:
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
-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"' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-signatures' \
-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"' \
YAML
响应:
- 如果存在签名且全部有效,则返回200 OK。
- 如果没有签名或至少一个签名无效,将返回400 BadRequest结果。
[职位] 加密 / 添加密码和权限
端点: http://localhost:8080/v1/document-services/pdfs/encrypt
描述:通过使用用户和所有者密码对PDF文档进行加密,为其添加了一层安全保护。 在请求体中包含一个作为 pdf_file 对象的 PDF 文件。
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 要加密的PDF文件。 |
允许提取内容 | bool | 允许从PDF文件中提取内容。 |
允许填写表单 | bool | 允许在生成的PDF中填写表单。 |
允许注释 | bool | 允许在生成的PDF中添加或修改注释。 |
允许打印 | bool | 允许打印生成的PDF。 |
允许修改 | bool | 允许对生成的PDF进行修改。 |
new_owner_password | 字符串 | 输出PDF的新所有者密码。授予完全访问权限,包括更改权限和密码。 |
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
new_user_password | 字符串 | 空 | 输出PDF的新用户密码。授予读取访问权限和其他指定权限。 |
save_as_pdfa | bool | 假的 | 将 PDF 保存为符合 PDF/A-3 的格式。 |
保存为PDF/UA | bool | 假的 | 保存 PDF 并符合 PDF/UA 规范。 |
可选标题
名字 | 数据类型 | 说明 |
---|
作者 | 字符串 | 设置 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 -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 -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
响应:
[职位] 从文档中提取文本
Endpoint: http://localhost:8080/v1/document-services/pdfs/extract
描述:提取嵌入文档页面中的文本。 在请求正文中包含一个PDF文件作为pdf_file
对象。
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | 要加密的PDF文件。 |
可选请求体参数
名字 | 数据类型 | 默认值 | 说明 |
---|
用户密码 | 字符串 | 空 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 空 | 用于输入PDF的所有者密码。如果PDF具有所有者密码以授予修改权限,则为必需。 |
specific_pages | 数组[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 -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 -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
响应:
[职位] 验证文档密码
端点: http://localhost:8080/v1/document-services/pdfs/verify-password
描述:验证提供的用户密码和所有者密码是否对 pdf_file
有效
必需的请求主体参数
名字 | 数据类型 | 说明 |
---|
pdf_file | 应用程序/pdf 文件 | PDF文件。 |
用户密码 | 字符串 | 输入PDF的用户密码。如果PDF有用户密码以授予读取权限,则为必需。 |
owner_password | 字符串 | 输入PDF的所有者密码。 |
示例:
请求
仅为必填参数:
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
-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"' \
curl -X POST 'https://api.securedoc.com/v1/document-services/pdfs/verify-password' \
-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"' \
YAML
响应: