文档转 PDF

概述

使用流程

由于转换需要时间，文件越大页数越多，转换越久，故默认采用异步的方式获得转换结果。即调用转换接口后会获得token，随后有2种方式查询转换结果：

1. 定时轮询结果，调用“查询结果接口”。详细见：查询结果
2. 回调，设置callbackurl，当转换结束后，系统会回调该URL直接推送转换结果。详细见：回调URL

调用转换接口

v1和v2接口功能相同，调用方式不一样。v2支持同步转换，v1不支持，推荐用v2接口。

v2接口统一为HTTP POST JSON：

• JSON支持输入：文件url；文件Base64字符串；多张图片的url。见：文档转换_v2
• v2版本的API除了异步，还支持同步调用，见：同步调用
• v2版本中的参数如果未出现在v1版本中，v1版本用同样参数也能工作

v1接口包括3种转换方式：

• 单一文档转为PDF，文档是一个下载链接，用HTTP GET方式，见：文档转换GET_v1
• 单一文档转为PDF，文档POST到服务器，用HTTP POST Form Data方式，见：文档转换POST_v1
• 多个图片转为PDF，文档是多个下载链接，用HTTP POST JSON方式，见：多张图片转换POST_v1

调用文件操作接口

• 文件操作接口v1和v2类似，v2支持同步和异步，v1只支持异步。见文件操作

调用转换API需要签名，详细见文档附录：阿里签名 调用查询结果API无需签名。

---

阿里云支持从OSS内网直接下载文件，节约流量，见：阿里云独有部分

文档转换_v2

异步url：

https://doc2pdf.market.alicloudapi.com/v2/convert_async

同步url：

https://doc2pdf.market.alicloudapi.com/v2/convert_sync

HTTP方式： POST

Header中的Content-Type传入application/json

Body是JSON格式，支持以下3种输入源文件的方法：

方法1: 文件url，最大1500M：

{"input": ["http://xxx.docx"]}

方法2: 文件Base64字符串，注意需要传入type（源文档类型），Base64字符串最大8M：

{"input": ["base64字符串"], "type": "docx"}

方法3: 多张图片url，注意只能是图片：

{"input": ["http://xxx.jpg", "http://xxx.png"]}

必须签名才能调用成功，签名见阿里签名规则:

https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/use-cases/call-apis

支持以下源文件格式：

自定义参数:

请求示例:

• 例1: 把word文件转为PDF，并设置1级压缩

{"input": ["http://xxx.docx"], "compress":1}

• 例2: 把2张图片转为PDF，并识别图中文字，去除图片，转为矢量文字可选的PDF

{"input":["http://xxx.jpg", "http://xxx.png"], "ocr":1, "clean":1, "text":1}

• 例3: 把Excel文件转为PDF，并只包含有内容的单元格，加上水印"度慧科技"，设置PDF打开密码为123

{"input":["http://xxx.xlsx"], "exceluseprintarea":2, "watermark":"度慧科技", "userpassword":"YOUR_PASSWORD"}

• 例4: 把 Excel 文件转为 PDF，并将每张工作表调整为一页

{"input":["http://xxx.xlsx"], "excelpagefitmode":2}

返回数据结构【异步】:

result:

返回示例(成功状态)【异步】:

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态)【异步】:

{
	"code":40001,
	"msg":"ParmNotRight"
}

同步调用

同步调用的最大返回时间是60秒，如果60秒内转换结束则直接返回结果。否则会返回token，之后和异步方式一样可以调用查询结果接口查询该token的转换结果。所以同步调用如果传入的文件过大，无法保证在60秒内结束，则转为异步流程。

返回数据结构【同步】:

result:

返回示例(成功状态)【同步】:

{
	"code": 10000,
	"msg": "",
	"result": {
		"count": 1,
		"filesize": 17747,
		"pdfurl": "https://file.duhuitech.com/o/xxx/xxx.pdf",
		"status": "Done"
	},
	"token": "YOUR_CREDENTIAL"
}

返回示例(超时状态)【同步】:

{
	"code": 40500,
	"msg": "Timeout, query token later",
	"token": "YOUR_CREDENTIAL"
}

文件操作_v1/v2

v1和v2的文件操作功能基本相同，共用以下action、请求参数和示例。区别仅在调用入口和返回方式：

• v1请求url是 https://doc2pdf.market.alicloudapi.com/v1/pdfaction，仅支持异步调用
• v2请求url分为异步和同步：异步是 https://doc2pdf.market.alicloudapi.com/v2/action_async，同步是 https://doc2pdf.market.alicloudapi.com/v2/action_sync
• v2同步调用最多等待60秒，超时后会返回token，转入和异步相同的查询结果流程，详细见 同步调用
• 下面的action说明、JSON Body参数和示例，v1/v2通用

支持以下操作：

POST Body传入JSON，Header中的Content-Type传入application/json

通过指定action，对PDF文件进行不同的操作，详细如下：

文件处理

• 文件合并：

专属参数：无。

示例：

{"action":"merge","url":["https://xxx/xxx.pdf", "https://xxx/xxx.pdf"]}

会合并为一个PDF文件。url数组需传2个以上PDF地址。

• 文件拆分：

支持的专属参数：splitcount（按固定页数拆分）、pageranges（按多个页段拆分，使用竖线分隔；和 splitcount 同时传时优先按 splitcount）。

示例：

{"action":"split","url":["https://xxx/xxx.pdf"],"splitcount":2}

会把PDF拆分为多个PDF，每个PDF是2页。

{"action":"split","url":["https://xxx/xxx.pdf"],"pageranges":"1-3|4-10|11-12"}

会按 pageranges 指定的页段拆分为多个PDF，依次输出为1.pdf、2.pdf、3.pdf。

pdffilename 不支持；拆分结果文件会按 1.pdf、2.pdf、3.pdf 这类顺序命名。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"pdfurls":["https://file.duhuitech.com/o/xxx/1.pdf","https://file.duhuitech.com/o/xxx/2.pdf","https://file.duhuitech.com/o/xxx/3.pdf"]}}

• 转为图片PDF：

支持的专属参数：compress（可选，默认0不压缩）。

示例：

{"action":"imagepdf","url":["https://xxx/xxx.pdf"],"compress":2}

会把PDF每一页转成图片后再重新生成一个图片型PDF。

• 文件修复：

专属参数：无。

示例：

{"action":"repairpdf","url":["https://xxx/xxx.pdf"]}

会尝试修复PDF结构问题，并输出修复后的PDF。

• 文件扁平化：

专属参数：无。

示例：

{"action":"flatten","url":["https://xxx/xxx.pdf"]}

会把PDF中的批注等可交互内容扁平化到页面内容里。

• 文件线性化：

专属参数：无。

示例：

{"action":"linearize","url":["https://xxx/xxx.pdf"]}

会把PDF做快速网页预览优化。

• PDF压缩：

支持的专属参数：compress（必传，支持1、2、3，也支持直接传目标图片分辨率）。

示例：

{"action":"compresspdf","url":["https://xxx/xxx.pdf"],"compress":2}

压缩PDF；如果压缩结果不比原文件更小，会保留较小版本输出。

• PDF净化：

专属参数：无。

示例：

{"action":"pdfsanitize","url":["https://xxx/xxx.pdf"]}

会重写PDF结构并清空常见元数据字段，输出净化后的PDF。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12,"pdfurl":"https://file.duhuitech.com/o/xxx/sanitize.pdf","data":{}}}

• PDF灰度化：

专属参数：无。

示例：

{"action":"grayscale","url":["https://xxx/xxx.pdf"]}

会把PDF转换为灰度版，并输出新的PDF。

内容叠加与排版

• 图片签名：

支持的专属参数：pageindex（签名页码）、stampurl（签名图片地址）、stamprect（签名位置和大小，格式 x,y,width,height）。

示例：

{"action":"stampsignature","url":["https://xxx/xxx.pdf"],"pageindex":1,"stampurl":"http://xxx/xxx.png","stamprect":"10,10,100,50"}

会把PDF的第一页加上图片签名，签名位置在x=10，y=10，宽度=100，高度=50，单位像素。

• 文件加水印：

支持的专属参数：watermark、watermarkstyle、watermarkfontsize、watermarkfontcolor、watermarkfontalpha。

示例：

{"action":"watermark","url":["https://xxx/xxx.pdf"],"watermark":"CONFIDENTIAL","watermarkstyle":1,"watermarkfontsize":24,"watermarkfontcolor":"#000000","watermarkfontalpha":20}

会给PDF每一页添加文字水印。

• 文件去水印：

专属参数：无。

示例：

{"action":"removewatermark","url":["https://xxx/xxx.pdf"]}

会尝试移除PDF中的水印内容，并输出新的PDF。

• PDF前景叠加：

支持的专属参数：data.repeat（可选，控制是否把第 2 个 PDF 按页序循环铺到所有页面）。

示例：

{"action":"overlaypdf","url":["https://xxx/base.pdf","https://xxx/overlay.pdf"],"data":{"repeat":1}}

行为说明：不传 data.repeat 时，默认只会按第 2 个 PDF 的实际页数逐页做前景叠加，超出的底稿页不再叠加；传 1 时会按页序循环铺到所有页面。若第 2 个 PDF 只有 1 页，即使不传 data.repeat，系统也会自动把这一页铺到所有页面。

会把第2个PDF作为前景叠加到第1个PDF上，并输出新的PDF。url固定传2个PDF，第1个是底稿PDF。

• PDF背景叠加：

支持的专属参数：data.repeat（可选，控制是否把第 2 个 PDF 按页序循环铺到所有页面）。

示例：

{"action":"underlaypdf","url":["https://xxx/base.pdf","https://xxx/background.pdf"],"data":{"repeat":1}}

行为说明：不传 data.repeat 时，默认只会按第 2 个 PDF 的实际页数逐页做背景叠加，超出的底稿页不再叠加；传 1 时会按页序循环铺到所有页面。若第 2 个 PDF 只有 1 页，即使不传 data.repeat，系统也会自动把这一页铺到所有页面。

会把第2个PDF作为背景叠加到第1个PDF下方，并输出新的PDF。url固定传2个PDF，第1个是底稿PDF。

• 页眉页脚：

支持的专属参数：data.header、data.footer、data.fontsize、data.fontcolor、data.fontalpha。

示例：

{"action":"headerfooter","url":["https://xxx/xxx.pdf"],"data":{"header":"Confidential","footer":"第 {{page}} / {{total}} 页","fontsize":12,"fontcolor":"#333333","fontalpha":80}}

会给每一页叠加文字页眉页脚。

• 页面加页码：

专属参数：无。

示例：

{"action":"pageaddnumber","url":["https://xxx/xxx.pdf"]}

会把PDF每一页右下角添加页码。

• PDF多页拼版 / n-up：

支持的专属参数：data.nup、data.paper、data.landscape、data.frame、data.scale。

常见纸张说明：

• a4paper：最常见的办公打印纸；如果不确定，优先用它。
• a3paper：比 A4 更大，适合一次拼更多页。
• a5paper：比 A4 更小，适合输出更小的页面。
• letterpaper：北美常见纸型。
• legalpaper：比 letterpaper 更长，常用于合同、表格。

示例 1：一张纸放 4 页，适合做讲义或速读版

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x2","paper":"a4paper","landscape":1,"frame":1,"scale":0.95}}

示例 2：一张纸放 2 页，保留更大的阅读字号

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x1","paper":"a4paper"}}

示例 3：放到更大的纸上，减少内容拥挤

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x2","paper":"a3paper","scale":0.9}}

这个操作会把多页 PDF 重新排到一张纸上。原文件里的超链接、书签、表单等交互信息可能不会保留。

• PDF小册子排版：

支持的专属参数：data.paper、data.landscape、data.scale、data.signature、data.flipotheredge。

signature 可以简单理解为“分几本小册子来装订”：

• signature=16：每 16 页做成一个装订单元。
• signature=32：每 32 页做成一个装订单元。
• 不传：整份 PDF 当成一个小册子，系统会自动补空白页到 4 的倍数。

示例 1：整份 PDF 直接做成一本小册子

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper"}}

示例 2：每 16 页做一个装订单元，适合页数较多的文档

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper","signature":16,"flipotheredge":1,"scale":0.95}}

示例 3：如果双面打印背面方向不对，可尝试切换翻页边

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper","signature":16,"flipotheredge":1}}

这个操作会按小册子阅读顺序重新排页，并在需要时自动补空白页，适合双面打印后对折装订。原文件里的超链接、书签、表单等交互信息可能不会保留。

页面处理

• 页面删除：

支持的专属参数：pageindexes（要删除的页码字符串，支持区间组合；按页码集合删除选中页，不按输入顺序重排）。

示例：

{"action":"pageremove","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3"}

会把PDF里的第一页、第三页删除；若传入 3,1 或 1,3,4-5，也是按页码集合选中后删除，不会因为输入顺序改变删除逻辑。

• 页面插入：

支持的专属参数：pageindex（插入位置）、pageinserturl（插入的PDF地址）。

示例：

{"action":"pageinsert","url":["https://xxx/xxx.pdf"],"pageindex":1,"pageinserturl":"https://xxx/xxx.pdf"}

会在PDF的第一页后面插入 pageinserturl 这个地址的PDF。

• 页面提取：

支持的专属参数：pageindexes（要提取的页码字符串，支持区间组合、乱序和列表/区间混合；结果按给定顺序输出）。

示例：

{"action":"pageextract","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3"}

会把PDF里的第一页、第三页提取出来作为一个PDF文件；也支持如 3,1,2,5-6 这样的页序写法。

• 页面重排：

支持的专属参数：pageindexes（最终页序，支持乱序、范围和列表/区间混合）。

示例：

{"action":"pageorder","url":["https://xxx/xxx.pdf"],"pageindexes":"3,1,2,5-6"}

会按给定顺序重新生成一个PDF文件。

• 页面倒序：

专属参数：无。

示例：

{"action":"pagereverse","url":["https://xxx/xxx.pdf"]}

会把PDF所有页面整体倒序输出。

• 页面复制：

支持的专属参数：pageindexes（可选；不传则每页复制一遍，传则按原PDF页序在原位复制指定页，支持区间组合）。

示例：

{"action":"pageduplicate","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3,5-6"}

会在原页面后面插入对应页面副本；若传入 3,1，仍按原PDF页序在第1页、第3页后插入副本。

• 空白页插入：

支持的专属参数：pageindex（插入位置，0表示插到第一页前）。

示例：

{"action":"blankpageinsert","url":["https://xxx/xxx.pdf"],"pageindex":2}

会在第2页后插入1个同尺寸空白页。

• 自动删除空白页：

专属参数：无。

示例：

{"action":"removeblankpages","url":["https://xxx/xxx.pdf"]}

会自动识别接近纯白的页面并删除，适合扫描件里的空白隔页清理。

• 页面旋转：

支持的专属参数：pagerotateangle（旋转角度）、pageindexes（可选，按原PDF页序筛选指定页面）。

示例：

{"action":"pagerotate","url":["https://xxx/xxx.pdf"],"pagerotateangle":90,"pageindexes":"2,4-6"}

会把PDF整本或指定页面按给定角度旋转；若传入 3,1，会旋转第1页和第3页，但不会重排页面。

• PDF裁边：

支持的专属参数：pageindexes、data.left、data.right、data.top、data.bottom。

示例：

{"action":"pdfcrop","url":["https://xxx/xxx.pdf"],"pageindexes":"2-10","data":{"left":18,"right":18,"top":24,"bottom":24}}

会按统一边距修改选中页面的CropBox，并输出新的pdfurl。pageindexes 仅用于筛选要裁边的页面，不会因为输入顺序而重排页面。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12,"pdfurl":"https://file.duhuitech.com/o/xxx/crop.pdf","data":{"uniform":true,"pages":[{"page":1,"width":559.28,"height":805.89,"orientation":"portrait"}]}}}

• PDF页数查询：

专属参数：无。

示例：

{"action":"pagecountinfo","url":["https://xxx/xxx.pdf"]}

会只查询PDF页数。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12}}

• PDF页面信息：

支持的专属参数：pageindexes（可选；不传返回全部页面，传则按原PDF页序返回指定页）。

示例：

{"action":"pageinfo","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3-4"}

会返回每一页的宽高和横竖版信息；若传入 3,1，返回结果仍按第1页、第3页的原PDF页序排列。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"data":{"uniform":false,"pages":[{"page":1,"width":595.28,"height":841.89,"orientation":"portrait"},{"page":3,"width":841.89,"height":595.28,"orientation":"landscape"},{"page":4,"width":595.28,"height":595.28,"orientation":"square"}]}}}

内容提取与结构

• 提取图片：

专属参数：无。

示例：

{"action":"extractimg","url":["https://xxx/xxx.pdf"]}

会把PDF里的图片提取出来。

pdffilename 不支持；导出的图片文件会按 1.png、2.png 这类顺序命名。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":2,"imageurls":["https://file.duhuitech.com/o/xxx/1.png","https://file.duhuitech.com/o/xxx/2.png"]}}

• PDF文本提取：

支持的专属参数：pageindexes、outfilename、data.textwithformat、data.textperpage。

示例：

{"action":"extracttext","url":["https://xxx/xxx.pdf"],"pageindexes":"1-3","outfilename":"chapter1","data":{"textwithformat":1,"textperpage":1}}

会提取PDF文字内容；默认输出一个txt文件，textperpage 为1时输出按筛选后页序分拆的zip文件。

pdffilename 不适用，请使用 outfilename 控制输出文件名前缀。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"filesize":2048,"fileurl":"https://file.duhuitech.com/o/xxx/chapter1.zip"}}

• PDF元数据读取/修改：

支持的专属参数：meta.title、meta.author、meta.subject、meta.keywords、meta.creator、meta.producer。

示例：

{"action":"pdfmeta","url":["https://xxx/xxx.pdf"],"meta":{"title":"Quarterly Report","author":"Duhui"}}

不传 meta 时会读取当前PDF的常用元数据；传 meta 时会更新对应字段并返回新的pdfurl和更新后的data。

读取模式下 pdffilename 不适用；写入模式下支持 pdffilename。

返回结果重点字段：

返回结果示例（读取）：

{"result":{"status":"done","count":12,"data":{"title":"Quarterly Report","author":"Duhui","creator":"Word","producer":"Skia/PDF m123"}}}

更新模式下，返回结果会额外包含 result.pdfurl。

• PDF目录导出：

专属参数：无。

示例：

{"action":"outlineexport","url":["https://xxx/xxx.pdf"]}

会读取PDF目录书签。

pdffilename 不适用。

返回结果重点字段：

目录节点还可能包含 dest_name、color、flags、count、is_open 等可选字段。

返回结果示例：

{"result":{"status":"done","count":12,"data":{"named_dests":{},"outline":[{"title":"Chapter 1","dest":{"page_index":0,"dest":["/Fit"]},"kids":[{"title":"Section 1.1","dest":{"page_index":1,"dest":["/Fit"]}}]}]}}}

• PDF目录导入：

支持的专属参数：data（目录 JSON 对象，建议先调用 outlineexport 获取后原样传回）。

示例：

{"action":"outlineimport","url":["https://xxx/xxx.pdf"],"data":{"named_dests":{},"outline":[{"title":"Chapter 1","dest":{"page_index":0,"dest":["/Fit"]}}]}}

会把目录JSON写回PDF，并输出新的pdfurl。data 顶层应包含 named_dests 和 outline；其中 page_index 从 0 开始计数。

安全与权限

• 文件加密：

支持的专属参数：userpassword、ownerpassword、pdfrestriction。

示例：

{"action":"encrypt","url":["https://xxx/xxx.pdf"],"userpassword":"YOUR_PASSWORD","ownerpassword":"YOUR_PASSWORD","pdfrestriction":"110"}

userpassword 和 ownerpassword 至少传一个。该操作会给PDF加密码和权限限制。

• 文件解密（文件加密转换接口中已有）：

支持的专属参数：password（解密密码，可以为空）。

示例：

{"action":"decrypt","url":["https://xxx/xxx.pdf"],"password":""}

会把PDF解密。

• 文件是否加密：

专属参数：无。

示例：

{"action":"checkencrypt","url":["https://xxx/xxx.pdf"]}

会检查PDF是否加密。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","data":{"encrypted":true}}}

通用请求参数BODY（JSON）:

其余参数均为 action 专属参数，见对应 action 小节。

请求：

v1异步url：

https://doc2pdf.market.alicloudapi.com/v1/pdfaction

v2异步url：

https://doc2pdf.market.alicloudapi.com/v2/action_async

v2同步url：

https://doc2pdf.market.alicloudapi.com/v2/action_sync

HTTP方式：POST

Header中的Content-Type必须是application/json

传入的Body为JSON格式，见上方详细操作。

必须签名才能调用成功，签名见阿里签名规则:

https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/use-cases/call-apis

返回数据结构【v1异步 / v2异步】:

result:

异步任务完成后的通用说明：

• 所有 action 都支持 callbackurl。
• 大多数生成 PDF 的 action 都支持 pdffilename；任务完成后，可在 查询结果 或回调结果里看到 result.pdfurl、result.count，通常还会返回 result.filesize。
• 特殊 action 的最终返回字段见对应 action 小节，例如：split 返回 result.pdfurls，extractimg 返回 result.imageurls，extracttext 返回 result.fileurl，pagecountinfo、pageinfo、outlineexport、checkencrypt 等返回结构化数据。

返回示例(成功状态)【异步】:

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态)【异步】:

{
	"code":40001,
	"msg":"ParmNotRight"
}

返回数据结构【v2同步】:

v2同步调用会在60秒内尽量直接返回结果，超时则返回token并转入查询结果流程；返回结构参照上文 同步调用。

查询结果

请求参数:

请求示例:

https://api.duhuitech.com/q?token=YOUR_TOKEN

无需签名，无调用次数限制

由于转换需要时间，文件越大页数越多，转换越久，故需要轮询查询接口来获得结果。查询频率可以是1s一次，也可以更长一些。 查询后先看status，如果是Done或Failed，则转换结束，停止轮询。如果是Doing或Pending，则继续轮询。

返回数据结构:

result:

返回示例(成功状态):

{
	"code":10000,
	"msg":"",
	"token":"YOUR_CREDENTIAL",
	"result":
	{
		"progress":0.02,
		"status":"Doing"
	}
}

{
	"code":10000,
	"msg":"",
	"token":"YOUR_CREDENTIAL",
	"result":
	{
		"status":"Done",
		"pdfurl":"https://file.duhuitech.com/o/xxx/xxx.pdf",
		"count":10,
		"filesize":17747
	}
}

返回示例(失败状态):

{
	"code":40000,
	"msg":"No such token"
}

备注：

• 文件url方式支持文件大小 1500M。
• 如果图片开启OCR，最大支持的图片大小长边不超过8000像素。
• 最大转换时长：1小时，超过时间未完成则自动失败。
• 转换完成后，下载链接有效时间：1小时。

上述最后2项有延长需求请联系客服：

---

回调URL：

用途： 客户可以自行部署服务器，系统转换结束后会调用客户提供的回调URL，直接发送转换结果，从而无需再轮询查询结果。

当设置了回调URL，转换结束后（无论成功失败），系统都会尝试调用该URL，具体如下：

以POST方式调用该URL，Header头中Content-Type: application/json

Body为JSON格式，内容和查询结果的结果相同，例如：

{
	"code":10000,
	"msg":"",
	"token":"YOUR_CREDENTIAL",
	"result":
	{
		"status":"Done",
		"pdfurl":"https://file.duhuitech.com/o/xxx/xxx.pdf",
		"count":10,
		"filesize":17747
	}
}

服务端收到该POST后需在10秒内返回HTTP STATUS CODE 200，视为调用成功，否则系统认为回调失败，会再次尝试。规则如下：

系统共计最多会调用3次回调URL，如果第一次失败，则等待3秒后尝试第二次，如果第二次失败，则等待5秒后尝试第三次，如果第三次失败，则不再尝试。

回调URL超时时间10秒。

---

关于下载转换后的文件需支持302跳转

接口返回的下载地址（如 fileurl / fileurls）会经 HTTP 302 跳转到实际文件。浏览器会自动跟随。

以下方式默认会跟随跳转，一般无需额外配置：

wget、Python requests / urllib、Node.js axios / got / fetch、Java OkHttp / HttpURLConnection、Go net/http、C# HttpClient、PHP file_get_contents、Objective-C / Swift NSURLSession / URLSession（含 Alamofire）

少数默认不跟随，需手动打开：

• curl：加 -L，如 curl -L -o out.bin "下载地址"
• Java java.net.http.HttpClient：设置 .followRedirects(HttpClient.Redirect.NORMAL)
• PHP curl 扩展：设置 CURLOPT_FOLLOWLOCATION => true

若只拿到 302 响应、本地没有文件内容，多半是未跟随跳转，按上面说明打开对应选项即可。

---

阿里云独有部分：

支持从阿里云OSS内网直接下载文件，目前支持的是上海地区的阿里云OSS内网：

oss-cn-shanghai-internal.aliyuncs.com

文档转换GET或多张图片转换POST里的url地址包含上述域名则自动支持

---

错误码表：

返回的code如果是10000，代表成功，其余是失败

附录：阿里签名方式

参考链接：

https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/use-cases/call-apis

在调用API商品时，首先您需要了解采用哪种API认证方式，云市场API商品的认证方式主要有以下两种方式。两种方式可同时使用，您可以根据不同情况来选择。

• 简单身份认证（AppCode）

• 签名认证

简单身份认证（AppCode）

简单认证（AppCode）调用API，有两种方式，一种是将AppCode放在Header中进行调用，一种是将AppCode放在Query参数中进行调用。

方式一：将AppCode放在Header中

在请求Header中添加一个Authorization参数。

Authorization字段的值的格式为APPCODE ＋ 半角空格 ＋APPCODE值。格式如下：

Authorization:APPCODE AppCode值

示例：

Authorization:APPCODE YOUR_CREDENTIAL

方式二：将AppCode放在Query中

在请求Query中添加AppCode参数（同时支持appcode , appCode , APPCODE , APPCode四种写法）。

AppCode参数的值为AppCode的值。

示例：

http://www.aliyum.com?AppCode=YOUR_CREDENTIAL

参考链接：https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/user-guide/call-an-api-operation-by-using-an-appcode

签名认证

比较复杂，推荐用阿里自己的SDK来调用，参考链接：https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/user-guide/use-digest-authentication-to-call-an-api

附录：旧v1接口

文档转换GET_v1

将文档下载地址url转换为PDF，type是源文档的type，比如要把docx转为pdf，type就是docx

请求参数:

请求示例:

https://doc2pdf.market.alicloudapi.com/v1/convert?url=https%3a%2f%2fxxx%2fxxx.docx

将所在url地址的docx文件转为PDF，type就是源文件的type，这个例子里就是docx

必须签名才能调用成功，签名见阿里签名规则:

https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/use-cases/call-apis

支持多种文件格式，type可传入如下格式：

返回数据结构:

result:

返回示例(成功状态):

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态):

{
	"code":40001,
	"msg":"ParmNotRight"
}

文档转换POST_v1

直接将单个文档POST到服务器，大小限制8M

请求参数:

请求示例:

https://doc2pdf.market.alicloudapi.com/v1/convert_post

Header中的Content-Type必须是multipart/form-data

必须签名才能调用成功，签名见阿里签名规则:

https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/use-cases/call-apis

支持多种文件格式，type可传入如下格式：

返回数据结构:

result:

返回示例(成功状态):

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态):

{
	"code":40001,
	"msg":"ParmNotRight"
}

多张图片转换POST_v1

将多张图片转换为pdf，url传入多张图片的地址，传入非图片格式无效

Header中的Content-Type传入application/json

POST Body传入JSON，格式如下：

请求参数BODY:

请求示例:

https://doc2pdf.market.alicloudapi.com/v1/convert

传入的Body为JSON格式，如下：

{ "url": ["http://xxx/xxx1.png", "http://xxx/xxx2.png"], "type": "img" }

必须签名才能调用成功，签名见阿里签名规则:

https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/use-cases/call-apis

例如要把多张图片OCR，变为文字可选的PDF，并且将斜的文字矫正，将图片背景去除，那么JSON就是：

{ "url": ["http://xxx/xxx1.png", "http://xxx/xxx2.png"], "type": "img", "ocr": 1, "deskew": 1, "clean": 1}

支持几乎所有图片格式

返回数据结构:

result:

返回示例(成功状态):

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态):

{
	"code":40001,
	"msg":"ParmNotRight"
}

附录：废弃接口

合并PDF文件POST（废弃，用文件操作代替）

将多个PDF文件合并为一个PDF，url传入多个PDF文件的地址

Header中的Content-Type传入application/json

POST Body传入JSON，格式如下：

请求参数BODY:

请求示例:

https://doc2pdf.market.alicloudapi.com/v1/merge

传入的Body为JSON格式，如下：

{ "url": ["http://xxx/xxx1.png", "http://xxx/xxx2.png"]}

必须签名才能调用成功，签名见阿里签名规则:

https://help.aliyun.com/zh/api-gateway/traditional-api-gateway/use-cases/call-apis

例如要把多个PDF合并为一个，并且开启快速web显示，加上水印，那么JSON就是：

{ "url": ["http://xxx/xxx1.png","http://xxx/xxx2.png"], "linearization":1, "watermark":"测试水印"}

返回数据结构:

result:

返回示例(成功状态):

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态):

{
	"code":40001,
	"msg":"ParmNotRight"
}

概述

2种转换方式

• 单一文档转为PDF，文档是一个下载链接，用HTTP GET方式，见：文档转换GET
• 多个图片转为PDF，文档是多个下载链接，用HTTP POST方式，见：多张图片转换POST

基本用法

由于转换需要时间，文件越大页数越多，转换越久，故系统采用异步的方式获得转换结果。调用转换接口后会获得token，随后有2种方式查询转换结果：

1. 用HTTP GET方式，轮询“查询 query接口”获得结果。详细见：查询 QUERY
2. 设置callbackurl，当转换结束后，系统会回调该URL直接推送转换结果。详细见：回调URL

API调用需要签名，详细见文档附录：百度签名

文档转换GET

将文档下载地址url转换为PDF，type是源文档的type，比如要把docx转为pdf，type就是docx

请求参数：

请求示例：

https://pdfconvert.api.bdymkt.com/v1/convert?url=https%3a%2f%2fxxx%2fxxx.docx

将所在url地址的docx文件转为PDF，type就是源文件的type，这个例子里就是docx

必须签名才能调用成功，签名见百度签名规则：

https://cloud.baidu.com/doc/APIGW/s/Ljx2m1qc4

支持多种文件格式，具体如下（type可传入如下格式）：

返回数据结构：

result:

返回示例(成功状态)：

{
    "code":10000,
    "msg":"",
    "result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态)：

{
    "code":40001,
    "msg":"ParmNotRight"
}

多张图片转换POST

将多张图片转换为pdf，url传入多张图片的地址，传入非图片格式无效

Header中的Content-Type传入application/json

POST Body传入JSON，格式如下：

请求参数BODY：

请求示例：

https://pdfconvert.api.bdymkt.com/v1/convert

传入的Body为JSON格式，如下：

{ "url": [ "http://xxx/xxx1.png","http://xxx/xxx2.png" ], "type": "png" }

必须签名才能调用成功，签名见百度签名规则：

https://cloud.baidu.com/doc/APIGW/s/Ljx2m1qc4

例如要把多张图片OCR，变为文字可选的PDF，并且将斜的文字矫正，将图片背景去除，那么JSON就是：

{ "url": [ "http://xxx/xxx1.png","http://xxx/xxx2.png" ], "type": "img", "ocr": 1, "deskew": 1, "clean": 1 }

支持几乎所有图片格式

返回数据结构：

result:

返回示例(成功状态)：

{
    "code":10000,
    "msg":"",
    "result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态)：

{
    "code":40001,
    "msg":"ParmNotRight"
}

文件操作POST

支持以下操作：

POST Body传入JSON，Header中的Content-Type传入application/json

通过指定action，对PDF文件进行不同的操作，详细如下：

文件处理

• 文件合并：

专属参数：无。

示例：

{"action":"merge","url":["https://xxx/xxx.pdf", "https://xxx/xxx.pdf"]}

会合并为一个PDF文件。url数组需传2个以上PDF地址。

• 文件拆分：

支持的专属参数：splitcount（按固定页数拆分）、pageranges（按多个页段拆分，使用竖线分隔；和 splitcount 同时传时优先按 splitcount）。

示例：

{"action":"split","url":["https://xxx/xxx.pdf"],"splitcount":2}

会把PDF拆分为多个PDF，每个PDF是2页。

{"action":"split","url":["https://xxx/xxx.pdf"],"pageranges":"1-3|4-10|11-12"}

会按 pageranges 指定的页段拆分为多个PDF，依次输出为1.pdf、2.pdf、3.pdf。

pdffilename 不支持；拆分结果文件会按 1.pdf、2.pdf、3.pdf 这类顺序命名。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"pdfurls":["https://file.duhuitech.com/o/xxx/1.pdf","https://file.duhuitech.com/o/xxx/2.pdf","https://file.duhuitech.com/o/xxx/3.pdf"]}}

• 转为图片PDF：

支持的专属参数：compress（可选，默认0不压缩）。

示例：

{"action":"imagepdf","url":["https://xxx/xxx.pdf"],"compress":2}

会把PDF每一页转成图片后再重新生成一个图片型PDF。

• 文件修复：

专属参数：无。

示例：

{"action":"repairpdf","url":["https://xxx/xxx.pdf"]}

会尝试修复PDF结构问题，并输出修复后的PDF。

• 文件扁平化：

专属参数：无。

示例：

{"action":"flatten","url":["https://xxx/xxx.pdf"]}

会把PDF中的批注等可交互内容扁平化到页面内容里。

• 文件线性化：

专属参数：无。

示例：

{"action":"linearize","url":["https://xxx/xxx.pdf"]}

会把PDF做快速网页预览优化。

• PDF压缩：

支持的专属参数：compress（必传，支持1、2、3，也支持直接传目标图片分辨率）。

示例：

{"action":"compresspdf","url":["https://xxx/xxx.pdf"],"compress":2}

压缩PDF；如果压缩结果不比原文件更小，会保留较小版本输出。

• PDF净化：

专属参数：无。

示例：

{"action":"pdfsanitize","url":["https://xxx/xxx.pdf"]}

会重写PDF结构并清空常见元数据字段，输出净化后的PDF。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12,"pdfurl":"https://file.duhuitech.com/o/xxx/sanitize.pdf","data":{}}}

• PDF灰度化：

专属参数：无。

示例：

{"action":"grayscale","url":["https://xxx/xxx.pdf"]}

会把PDF转换为灰度版，并输出新的PDF。

内容叠加与排版

• 图片签名：

支持的专属参数：pageindex（签名页码）、stampurl（签名图片地址）、stamprect（签名位置和大小，格式 x,y,width,height）。

示例：

{"action":"stampsignature","url":["https://xxx/xxx.pdf"],"pageindex":1,"stampurl":"http://xxx/xxx.png","stamprect":"10,10,100,50"}

会把PDF的第一页加上图片签名，签名位置在x=10，y=10，宽度=100，高度=50，单位像素。

• 文件加水印：

支持的专属参数：watermark、watermarkstyle、watermarkfontsize、watermarkfontcolor、watermarkfontalpha。

示例：

{"action":"watermark","url":["https://xxx/xxx.pdf"],"watermark":"CONFIDENTIAL","watermarkstyle":1,"watermarkfontsize":24,"watermarkfontcolor":"#000000","watermarkfontalpha":20}

会给PDF每一页添加文字水印。

• 文件去水印：

专属参数：无。

示例：

{"action":"removewatermark","url":["https://xxx/xxx.pdf"]}

会尝试移除PDF中的水印内容，并输出新的PDF。

• PDF前景叠加：

支持的专属参数：data.repeat（可选，控制是否把第 2 个 PDF 按页序循环铺到所有页面）。

示例：

{"action":"overlaypdf","url":["https://xxx/base.pdf","https://xxx/overlay.pdf"],"data":{"repeat":1}}

行为说明：不传 data.repeat 时，默认只会按第 2 个 PDF 的实际页数逐页做前景叠加，超出的底稿页不再叠加；传 1 时会按页序循环铺到所有页面。若第 2 个 PDF 只有 1 页，即使不传 data.repeat，系统也会自动把这一页铺到所有页面。

会把第2个PDF作为前景叠加到第1个PDF上，并输出新的PDF。url固定传2个PDF，第1个是底稿PDF。

• PDF背景叠加：

支持的专属参数：data.repeat（可选，控制是否把第 2 个 PDF 按页序循环铺到所有页面）。

示例：

{"action":"underlaypdf","url":["https://xxx/base.pdf","https://xxx/background.pdf"],"data":{"repeat":1}}

行为说明：不传 data.repeat 时，默认只会按第 2 个 PDF 的实际页数逐页做背景叠加，超出的底稿页不再叠加；传 1 时会按页序循环铺到所有页面。若第 2 个 PDF 只有 1 页，即使不传 data.repeat，系统也会自动把这一页铺到所有页面。

会把第2个PDF作为背景叠加到第1个PDF下方，并输出新的PDF。url固定传2个PDF，第1个是底稿PDF。

• 页眉页脚：

支持的专属参数：data.header、data.footer、data.fontsize、data.fontcolor、data.fontalpha。

示例：

{"action":"headerfooter","url":["https://xxx/xxx.pdf"],"data":{"header":"Confidential","footer":"第 {{page}} / {{total}} 页","fontsize":12,"fontcolor":"#333333","fontalpha":80}}

会给每一页叠加文字页眉页脚。

• 页面加页码：

专属参数：无。

示例：

{"action":"pageaddnumber","url":["https://xxx/xxx.pdf"]}

会把PDF每一页右下角添加页码。

• PDF多页拼版 / n-up：

支持的专属参数：data.nup、data.paper、data.landscape、data.frame、data.scale。

常见纸张说明：

• a4paper：最常见的办公打印纸；如果不确定，优先用它。
• a3paper：比 A4 更大，适合一次拼更多页。
• a5paper：比 A4 更小，适合输出更小的页面。
• letterpaper：北美常见纸型。
• legalpaper：比 letterpaper 更长，常用于合同、表格。

示例 1：一张纸放 4 页，适合做讲义或速读版

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x2","paper":"a4paper","landscape":1,"frame":1,"scale":0.95}}

示例 2：一张纸放 2 页，保留更大的阅读字号

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x1","paper":"a4paper"}}

示例 3：放到更大的纸上，减少内容拥挤

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x2","paper":"a3paper","scale":0.9}}

这个操作会把多页 PDF 重新排到一张纸上。原文件里的超链接、书签、表单等交互信息可能不会保留。

• PDF小册子排版：

支持的专属参数：data.paper、data.landscape、data.scale、data.signature、data.flipotheredge。

signature 可以简单理解为“分几本小册子来装订”：

• signature=16：每 16 页做成一个装订单元。
• signature=32：每 32 页做成一个装订单元。
• 不传：整份 PDF 当成一个小册子，系统会自动补空白页到 4 的倍数。

示例 1：整份 PDF 直接做成一本小册子

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper"}}

示例 2：每 16 页做一个装订单元，适合页数较多的文档

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper","signature":16,"flipotheredge":1,"scale":0.95}}

示例 3：如果双面打印背面方向不对，可尝试切换翻页边

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper","signature":16,"flipotheredge":1}}

这个操作会按小册子阅读顺序重新排页，并在需要时自动补空白页，适合双面打印后对折装订。原文件里的超链接、书签、表单等交互信息可能不会保留。

页面处理

• 页面删除：

支持的专属参数：pageindexes（要删除的页码字符串，支持区间组合；按页码集合删除选中页，不按输入顺序重排）。

示例：

{"action":"pageremove","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3"}

会把PDF里的第一页、第三页删除；若传入 3,1 或 1,3,4-5，也是按页码集合选中后删除，不会因为输入顺序改变删除逻辑。

• 页面插入：

支持的专属参数：pageindex（插入位置）、pageinserturl（插入的PDF地址）。

示例：

{"action":"pageinsert","url":["https://xxx/xxx.pdf"],"pageindex":1,"pageinserturl":"https://xxx/xxx.pdf"}

会在PDF的第一页后面插入 pageinserturl 这个地址的PDF。

• 页面提取：

支持的专属参数：pageindexes（要提取的页码字符串，支持区间组合、乱序和列表/区间混合；结果按给定顺序输出）。

示例：

{"action":"pageextract","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3"}

会把PDF里的第一页、第三页提取出来作为一个PDF文件；也支持如 3,1,2,5-6 这样的页序写法。

• 页面重排：

支持的专属参数：pageindexes（最终页序，支持乱序、范围和列表/区间混合）。

示例：

{"action":"pageorder","url":["https://xxx/xxx.pdf"],"pageindexes":"3,1,2,5-6"}

会按给定顺序重新生成一个PDF文件。

• 页面倒序：

专属参数：无。

示例：

{"action":"pagereverse","url":["https://xxx/xxx.pdf"]}

会把PDF所有页面整体倒序输出。

• 页面复制：

支持的专属参数：pageindexes（可选；不传则每页复制一遍，传则按原PDF页序在原位复制指定页，支持区间组合）。

示例：

{"action":"pageduplicate","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3,5-6"}

会在原页面后面插入对应页面副本；若传入 3,1，仍按原PDF页序在第1页、第3页后插入副本。

• 空白页插入：

支持的专属参数：pageindex（插入位置，0表示插到第一页前）。

示例：

{"action":"blankpageinsert","url":["https://xxx/xxx.pdf"],"pageindex":2}

会在第2页后插入1个同尺寸空白页。

• 自动删除空白页：

专属参数：无。

示例：

{"action":"removeblankpages","url":["https://xxx/xxx.pdf"]}

会自动识别接近纯白的页面并删除，适合扫描件里的空白隔页清理。

• 页面旋转：

支持的专属参数：pagerotateangle（旋转角度）、pageindexes（可选，按原PDF页序筛选指定页面）。

示例：

{"action":"pagerotate","url":["https://xxx/xxx.pdf"],"pagerotateangle":90,"pageindexes":"2,4-6"}

会把PDF整本或指定页面按给定角度旋转；若传入 3,1，会旋转第1页和第3页，但不会重排页面。

• PDF裁边：

支持的专属参数：pageindexes、data.left、data.right、data.top、data.bottom。

示例：

{"action":"pdfcrop","url":["https://xxx/xxx.pdf"],"pageindexes":"2-10","data":{"left":18,"right":18,"top":24,"bottom":24}}

会按统一边距修改选中页面的CropBox，并输出新的pdfurl。pageindexes 仅用于筛选要裁边的页面，不会因为输入顺序而重排页面。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12,"pdfurl":"https://file.duhuitech.com/o/xxx/crop.pdf","data":{"uniform":true,"pages":[{"page":1,"width":559.28,"height":805.89,"orientation":"portrait"}]}}}

• PDF页数查询：

专属参数：无。

示例：

{"action":"pagecountinfo","url":["https://xxx/xxx.pdf"]}

会只查询PDF页数。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12}}

• PDF页面信息：

支持的专属参数：pageindexes（可选；不传返回全部页面，传则按原PDF页序返回指定页）。

示例：

{"action":"pageinfo","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3-4"}

会返回每一页的宽高和横竖版信息；若传入 3,1，返回结果仍按第1页、第3页的原PDF页序排列。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"data":{"uniform":false,"pages":[{"page":1,"width":595.28,"height":841.89,"orientation":"portrait"},{"page":3,"width":841.89,"height":595.28,"orientation":"landscape"},{"page":4,"width":595.28,"height":595.28,"orientation":"square"}]}}}

内容提取与结构

• 提取图片：

专属参数：无。

示例：

{"action":"extractimg","url":["https://xxx/xxx.pdf"]}

会把PDF里的图片提取出来。

pdffilename 不支持；导出的图片文件会按 1.png、2.png 这类顺序命名。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":2,"imageurls":["https://file.duhuitech.com/o/xxx/1.png","https://file.duhuitech.com/o/xxx/2.png"]}}

• PDF文本提取：

支持的专属参数：pageindexes、outfilename、data.textwithformat、data.textperpage。

示例：

{"action":"extracttext","url":["https://xxx/xxx.pdf"],"pageindexes":"1-3","outfilename":"chapter1","data":{"textwithformat":1,"textperpage":1}}

会提取PDF文字内容；默认输出一个txt文件，textperpage 为1时输出按筛选后页序分拆的zip文件。

pdffilename 不适用，请使用 outfilename 控制输出文件名前缀。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"filesize":2048,"fileurl":"https://file.duhuitech.com/o/xxx/chapter1.zip"}}

• PDF元数据读取/修改：

支持的专属参数：meta.title、meta.author、meta.subject、meta.keywords、meta.creator、meta.producer。

示例：

{"action":"pdfmeta","url":["https://xxx/xxx.pdf"],"meta":{"title":"Quarterly Report","author":"Duhui"}}

不传 meta 时会读取当前PDF的常用元数据；传 meta 时会更新对应字段并返回新的pdfurl和更新后的data。

读取模式下 pdffilename 不适用；写入模式下支持 pdffilename。

返回结果重点字段：

返回结果示例（读取）：

{"result":{"status":"done","count":12,"data":{"title":"Quarterly Report","author":"Duhui","creator":"Word","producer":"Skia/PDF m123"}}}

更新模式下，返回结果会额外包含 result.pdfurl。

• PDF目录导出：

专属参数：无。

示例：

{"action":"outlineexport","url":["https://xxx/xxx.pdf"]}

会读取PDF目录书签。

pdffilename 不适用。

返回结果重点字段：

目录节点还可能包含 dest_name、color、flags、count、is_open 等可选字段。

返回结果示例：

{"result":{"status":"done","count":12,"data":{"named_dests":{},"outline":[{"title":"Chapter 1","dest":{"page_index":0,"dest":["/Fit"]},"kids":[{"title":"Section 1.1","dest":{"page_index":1,"dest":["/Fit"]}}]}]}}}

• PDF目录导入：

支持的专属参数：data（目录 JSON 对象，建议先调用 outlineexport 获取后原样传回）。

示例：

{"action":"outlineimport","url":["https://xxx/xxx.pdf"],"data":{"named_dests":{},"outline":[{"title":"Chapter 1","dest":{"page_index":0,"dest":["/Fit"]}}]}}

会把目录JSON写回PDF，并输出新的pdfurl。data 顶层应包含 named_dests 和 outline；其中 page_index 从 0 开始计数。

安全与权限

• 文件加密：

支持的专属参数：userpassword、ownerpassword、pdfrestriction。

示例：

{"action":"encrypt","url":["https://xxx/xxx.pdf"],"userpassword":"YOUR_PASSWORD","ownerpassword":"YOUR_PASSWORD","pdfrestriction":"110"}

userpassword 和 ownerpassword 至少传一个。该操作会给PDF加密码和权限限制。

• 文件解密（文件加密转换接口中已有）：

支持的专属参数：password（解密密码，可以为空）。

示例：

{"action":"decrypt","url":["https://xxx/xxx.pdf"],"password":""}

会把PDF解密。

• 文件是否加密：

专属参数：无。

示例：

{"action":"checkencrypt","url":["https://xxx/xxx.pdf"]}

会检查PDF是否加密。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","data":{"encrypted":true}}}

通用请求参数BODY（JSON）:

其余参数均为 action 专属参数，见对应 action 小节。

请求示例：

https://pdfconvert.api.bdymkt.com/v1/pdfaction

传入的Body为JSON格式，见上方详细操作。

必须签名才能调用成功，签名见百度签名规则：

https://cloud.baidu.com/doc/APIGW/s/Ljx2m1qc4

返回数据结构:

result:

异步任务完成后的通用说明：

• 所有 action 都支持 callbackurl。
• 大多数生成 PDF 的 action 都支持 pdffilename；任务完成后，可在 查询结果 或回调结果里看到 result.pdfurl、result.count，通常还会返回 result.filesize。
• 特殊 action 的最终返回字段见对应 action 小节，例如：split 返回 result.pdfurls，extractimg 返回 result.imageurls，extracttext 返回 result.fileurl，pagecountinfo、pageinfo、outlineexport、checkencrypt 等返回结构化数据。

返回示例(成功状态):

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态):

{
	"code":40001,
	"msg":"ParmNotRight"
}

查询 QUERY

请求参数：

请求示例：

https://api.duhuitech.com/q?token=YOUR_TOKEN

无需签名，无调用次数限制

由于转换需要时间，文件越大页数越多，转换越久，故需要轮询查询接口来获得结果。查询频率可以是1s一次，也可以更长一些。查询后先看status，如果是Done或Failed，则转换结束，停止轮询。如果是Doing或Pending，则继续轮询。

返回数据结构：

result:

返回示例(成功状态)：

{
    "code":10000,
    "msg":"",
    "token":"YOUR_CREDENTIAL",
    "result":
    {
        "progress":0.02,
        "status":"Doing"
    }
}

{
    "code":10000,
    "msg":"",
    "token":"YOUR_CREDENTIAL",
    "result":
    {
        "status":"Done",
        "pdfurl":"https://file.duhuitech.com/o/xxx/xxx.pdf",
        "count":10
    }
}

返回示例(失败状态)：

{
    "code":40000,
    "msg":"No such token"
}

注意：

• 上传文件大小不能超过1500M。
• 最大转换时长：1小时，超过时间未完成则自动失败。
• 转换完成后，下载链接有效时间：1小时。

上述最后2项有延长需求请联系客服：

回调URL：

用途：客户可以自行部署服务器，系统转换结束后会调用客户提供的回调URL，直接发送转换结果，从而无需再轮询Query。

当设置了回调URL，转换结束后（无论成功失败），系统都会尝试调用该URL，具体如下：

以POST方式调用该URL，Header头中Content-Type: application/json

Body为JSON格式，内容和Query的结果相同，例如：

{"code":10000,"msg":"","token":"YOUR_CREDENTIAL","result":{"status":"Done","pdfurl":"https://file.duhuitech.com/o/xxx/xxx.pdf","count":10}}

服务端收到该POST后需在10秒内返回HTTP STATUS CODE 200，视为调用成功，否则系统认为回调失败，会再次尝试。规则如下：

系统共计最多会调用3次回调URL，如果第一次失败，则等待3秒后尝试第二次，如果第二次失败，则等待5秒后尝试第三次，如果第三次失败，则不再尝试。

回调URL超时时间10秒。

---

关于下载转换后的文件需支持302跳转

接口返回的下载地址（如 fileurl / fileurls）会经 HTTP 302 跳转到实际文件。浏览器会自动跟随。

以下方式默认会跟随跳转，一般无需额外配置：

wget、Python requests / urllib、Node.js axios / got / fetch、Java OkHttp / HttpURLConnection、Go net/http、C# HttpClient、PHP file_get_contents、Objective-C / Swift NSURLSession / URLSession（含 Alamofire）

少数默认不跟随，需手动打开：

• curl：加 -L，如 curl -L -o out.bin "下载地址"
• Java java.net.http.HttpClient：设置 .followRedirects(HttpClient.Redirect.NORMAL)
• PHP curl 扩展：设置 CURLOPT_FOLLOWLOCATION => true

若只拿到 302 响应、本地没有文件内容，多半是未跟随跳转，按上面说明打开对应选项即可。

---

错误码表：

附录：百度签名方式

参考链接：

https://cloud.baidu.com/doc/APIGW/s/Ljx2m1qc4

在调用API商品时，首先您需要了解采用哪种API认证方式，云市场API商品的认证方式主要有以下两种方式。两种方式可同时使用，您可以根据不同情况来选择。

• 简单身份认证（AppCode）
• 签名认证

简单身份认证（AppCode）

简单认证（AppCode）调用API，将AppCode放在Header中

在请求Header中添加一个X-Bce-Signature参数。

示例：

X-Bce-Signature: AppCode/YOUR_APPCODE

签名认证

比较复杂，推荐用百度自己的SDK来调用，参考链接：https://cloud.baidu.com/doc/Reference/s/njwvz1yfu

概述

3种转换方式

• 单一文档转为PDF，文档是一个下载链接，用HTTP GET方式，见：文档转换GET
• 单一文档转为PDF，文档POST到服务器，用HTTP POST方式，见：文档转换POST
• 多个图片转为PDF，文档是多个下载链接，用HTTP POST方式，见：多张图片转换POST

基本用法

由于转换需要时间，文件越大页数越多，转换越久，故系统采用异步的方式获得转换结果。调用转换接口后会获得token，随后有2种方式查询转换结果：

1. 用HTTP GET方式，轮询“查询 query接口”获得结果。详细见：查询 QUERY
2. 设置callbackurl，当转换结束后，系统会回调该URL直接推送转换结果。详细见：回调URL

API调用需要签名，详细见华为官方签名：

https://support.huaweicloud.com/usermanual-apig/apig-ug-0011.html

文档转换GET

将文档下载地址url转换为PDF，type是源文档的type，比如要把docx转为pdf，type就是docx

请求参数：

请求示例：

http://all2pdf.apistore.huaweicloud.com/v1/convert?url=https%3a%2f%2fxxx%2fxxx.docx&type=docx

将所在url地址的docx文件转为PDF，type就是源文件的type，这个例子里就是docx

必须签名才能调用成功，签名见华为签名规则：

https://support.huaweicloud.com/usermanual-apig/apig-ug-0011.html

支持多种文件格式，具体如下（type可传入如下格式）：

返回数据结构：

result:

返回示例(成功状态)：

{
    "code":10000,
    "msg":"",
    "result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态)：

{
    "code":40001,
    "msg":"ParmNotRight"
}

文档转换POST

直接将单个文档POST到服务器，大小限制12M

请求参数：

请求示例：

http://all2pdf.apistore.huaweicloud.com/v1/convert_post

Header中的Content-Type必须是multipart/form-data

必须签名才能调用成功，签名见华为签名规则：

https://support.huaweicloud.com/usermanual-apig/apig-ug-0011.html

支持多种文件格式，具体如下（type可传入如下格式）：

返回数据结构：

result:

返回示例(成功状态)：

{
    "code":10000,
    "msg":"",
    "result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态)：

{
    "code":40001,
    "msg":"ParmNotRight"
}

多张图片转换POST

将多张图片转换为pdf，url传入多张图片的地址，传入非图片格式无效

Header中的Content-Type传入application/json

POST Body传入JSON，格式如下：

请求参数BODY：

请求示例：

http://all2pdf.apistore.huaweicloud.com/v1/convert

传入的Body为JSON格式，如下：

{ "url": [ "http://xxx/xxx1.png","http://xxx/xxx2.png" ], "type": "png" }

必须签名才能调用成功，签名见华为签名规则：

https://support.huaweicloud.com/usermanual-apig/apig-ug-0011.html

例如要把多张图片OCR，变为文字可选的PDF，并且将斜的文字矫正，将图片背景去除，那么JSON就是：

{ "url": [ "http://xxx/xxx1.png","http://xxx/xxx2.png" ], "type": "img", "ocr": 1, "deskew": 1, "clean": 1 }

支持几乎所有图片格式

返回数据结构：

result:

返回示例(成功状态)：

{
    "code":10000,
    "msg":"",
    "result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态)：

{
    "code":40001,
    "msg":"ParmNotRight"
}

文件操作POST

支持以下操作：

POST Body传入JSON，Header中的Content-Type传入application/json

通过指定action，对PDF文件进行不同的操作，详细如下：

文件处理

• 文件合并：

专属参数：无。

示例：

{"action":"merge","url":["https://xxx/xxx.pdf", "https://xxx/xxx.pdf"]}

会合并为一个PDF文件。url数组需传2个以上PDF地址。

• 文件拆分：

支持的专属参数：splitcount（按固定页数拆分）、pageranges（按多个页段拆分，使用竖线分隔；和 splitcount 同时传时优先按 splitcount）。

示例：

{"action":"split","url":["https://xxx/xxx.pdf"],"splitcount":2}

会把PDF拆分为多个PDF，每个PDF是2页。

{"action":"split","url":["https://xxx/xxx.pdf"],"pageranges":"1-3|4-10|11-12"}

会按 pageranges 指定的页段拆分为多个PDF，依次输出为1.pdf、2.pdf、3.pdf。

pdffilename 不支持；拆分结果文件会按 1.pdf、2.pdf、3.pdf 这类顺序命名。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"pdfurls":["https://file.duhuitech.com/o/xxx/1.pdf","https://file.duhuitech.com/o/xxx/2.pdf","https://file.duhuitech.com/o/xxx/3.pdf"]}}

• 转为图片PDF：

支持的专属参数：compress（可选，默认0不压缩）。

示例：

{"action":"imagepdf","url":["https://xxx/xxx.pdf"],"compress":2}

会把PDF每一页转成图片后再重新生成一个图片型PDF。

• 文件修复：

专属参数：无。

示例：

{"action":"repairpdf","url":["https://xxx/xxx.pdf"]}

会尝试修复PDF结构问题，并输出修复后的PDF。

• 文件扁平化：

专属参数：无。

示例：

{"action":"flatten","url":["https://xxx/xxx.pdf"]}

会把PDF中的批注等可交互内容扁平化到页面内容里。

• 文件线性化：

专属参数：无。

示例：

{"action":"linearize","url":["https://xxx/xxx.pdf"]}

会把PDF做快速网页预览优化。

• PDF压缩：

支持的专属参数：compress（必传，支持1、2、3，也支持直接传目标图片分辨率）。

示例：

{"action":"compresspdf","url":["https://xxx/xxx.pdf"],"compress":2}

压缩PDF；如果压缩结果不比原文件更小，会保留较小版本输出。

• PDF净化：

专属参数：无。

示例：

{"action":"pdfsanitize","url":["https://xxx/xxx.pdf"]}

会重写PDF结构并清空常见元数据字段，输出净化后的PDF。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12,"pdfurl":"https://file.duhuitech.com/o/xxx/sanitize.pdf","data":{}}}

• PDF灰度化：

专属参数：无。

示例：

{"action":"grayscale","url":["https://xxx/xxx.pdf"]}

会把PDF转换为灰度版，并输出新的PDF。

内容叠加与排版

• 图片签名：

支持的专属参数：pageindex（签名页码）、stampurl（签名图片地址）、stamprect（签名位置和大小，格式 x,y,width,height）。

示例：

{"action":"stampsignature","url":["https://xxx/xxx.pdf"],"pageindex":1,"stampurl":"http://xxx/xxx.png","stamprect":"10,10,100,50"}

会把PDF的第一页加上图片签名，签名位置在x=10，y=10，宽度=100，高度=50，单位像素。

• 文件加水印：

支持的专属参数：watermark、watermarkstyle、watermarkfontsize、watermarkfontcolor、watermarkfontalpha。

示例：

{"action":"watermark","url":["https://xxx/xxx.pdf"],"watermark":"CONFIDENTIAL","watermarkstyle":1,"watermarkfontsize":24,"watermarkfontcolor":"#000000","watermarkfontalpha":20}

会给PDF每一页添加文字水印。

• 文件去水印：

专属参数：无。

示例：

{"action":"removewatermark","url":["https://xxx/xxx.pdf"]}

会尝试移除PDF中的水印内容，并输出新的PDF。

• PDF前景叠加：

支持的专属参数：data.repeat（可选，控制是否把第 2 个 PDF 按页序循环铺到所有页面）。

示例：

{"action":"overlaypdf","url":["https://xxx/base.pdf","https://xxx/overlay.pdf"],"data":{"repeat":1}}

行为说明：不传 data.repeat 时，默认只会按第 2 个 PDF 的实际页数逐页做前景叠加，超出的底稿页不再叠加；传 1 时会按页序循环铺到所有页面。若第 2 个 PDF 只有 1 页，即使不传 data.repeat，系统也会自动把这一页铺到所有页面。

会把第2个PDF作为前景叠加到第1个PDF上，并输出新的PDF。url固定传2个PDF，第1个是底稿PDF。

• PDF背景叠加：

支持的专属参数：data.repeat（可选，控制是否把第 2 个 PDF 按页序循环铺到所有页面）。

示例：

{"action":"underlaypdf","url":["https://xxx/base.pdf","https://xxx/background.pdf"],"data":{"repeat":1}}

行为说明：不传 data.repeat 时，默认只会按第 2 个 PDF 的实际页数逐页做背景叠加，超出的底稿页不再叠加；传 1 时会按页序循环铺到所有页面。若第 2 个 PDF 只有 1 页，即使不传 data.repeat，系统也会自动把这一页铺到所有页面。

会把第2个PDF作为背景叠加到第1个PDF下方，并输出新的PDF。url固定传2个PDF，第1个是底稿PDF。

• 页眉页脚：

支持的专属参数：data.header、data.footer、data.fontsize、data.fontcolor、data.fontalpha。

示例：

{"action":"headerfooter","url":["https://xxx/xxx.pdf"],"data":{"header":"Confidential","footer":"第 {{page}} / {{total}} 页","fontsize":12,"fontcolor":"#333333","fontalpha":80}}

会给每一页叠加文字页眉页脚。

• 页面加页码：

专属参数：无。

示例：

{"action":"pageaddnumber","url":["https://xxx/xxx.pdf"]}

会把PDF每一页右下角添加页码。

• PDF多页拼版 / n-up：

支持的专属参数：data.nup、data.paper、data.landscape、data.frame、data.scale。

常见纸张说明：

• a4paper：最常见的办公打印纸；如果不确定，优先用它。
• a3paper：比 A4 更大，适合一次拼更多页。
• a5paper：比 A4 更小，适合输出更小的页面。
• letterpaper：北美常见纸型。
• legalpaper：比 letterpaper 更长，常用于合同、表格。

示例 1：一张纸放 4 页，适合做讲义或速读版

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x2","paper":"a4paper","landscape":1,"frame":1,"scale":0.95}}

示例 2：一张纸放 2 页，保留更大的阅读字号

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x1","paper":"a4paper"}}

示例 3：放到更大的纸上，减少内容拥挤

{"action":"pdfnup","url":["https://xxx/xxx.pdf"],"data":{"nup":"2x2","paper":"a3paper","scale":0.9}}

这个操作会把多页 PDF 重新排到一张纸上。原文件里的超链接、书签、表单等交互信息可能不会保留。

• PDF小册子排版：

支持的专属参数：data.paper、data.landscape、data.scale、data.signature、data.flipotheredge。

signature 可以简单理解为“分几本小册子来装订”：

• signature=16：每 16 页做成一个装订单元。
• signature=32：每 32 页做成一个装订单元。
• 不传：整份 PDF 当成一个小册子，系统会自动补空白页到 4 的倍数。

示例 1：整份 PDF 直接做成一本小册子

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper"}}

示例 2：每 16 页做一个装订单元，适合页数较多的文档

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper","signature":16,"flipotheredge":1,"scale":0.95}}

示例 3：如果双面打印背面方向不对，可尝试切换翻页边

{"action":"pdfbooklet","url":["https://xxx/xxx.pdf"],"data":{"paper":"a4paper","signature":16,"flipotheredge":1}}

这个操作会按小册子阅读顺序重新排页，并在需要时自动补空白页，适合双面打印后对折装订。原文件里的超链接、书签、表单等交互信息可能不会保留。

页面处理

• 页面删除：

支持的专属参数：pageindexes（要删除的页码字符串，支持区间组合；按页码集合删除选中页，不按输入顺序重排）。

示例：

{"action":"pageremove","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3"}

会把PDF里的第一页、第三页删除；若传入 3,1 或 1,3,4-5，也是按页码集合选中后删除，不会因为输入顺序改变删除逻辑。

• 页面插入：

支持的专属参数：pageindex（插入位置）、pageinserturl（插入的PDF地址）。

示例：

{"action":"pageinsert","url":["https://xxx/xxx.pdf"],"pageindex":1,"pageinserturl":"https://xxx/xxx.pdf"}

会在PDF的第一页后面插入 pageinserturl 这个地址的PDF。

• 页面提取：

支持的专属参数：pageindexes（要提取的页码字符串，支持区间组合、乱序和列表/区间混合；结果按给定顺序输出）。

示例：

{"action":"pageextract","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3"}

会把PDF里的第一页、第三页提取出来作为一个PDF文件；也支持如 3,1,2,5-6 这样的页序写法。

• 页面重排：

支持的专属参数：pageindexes（最终页序，支持乱序、范围和列表/区间混合）。

示例：

{"action":"pageorder","url":["https://xxx/xxx.pdf"],"pageindexes":"3,1,2,5-6"}

会按给定顺序重新生成一个PDF文件。

• 页面倒序：

专属参数：无。

示例：

{"action":"pagereverse","url":["https://xxx/xxx.pdf"]}

会把PDF所有页面整体倒序输出。

• 页面复制：

支持的专属参数：pageindexes（可选；不传则每页复制一遍，传则按原PDF页序在原位复制指定页，支持区间组合）。

示例：

{"action":"pageduplicate","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3,5-6"}

会在原页面后面插入对应页面副本；若传入 3,1，仍按原PDF页序在第1页、第3页后插入副本。

• 空白页插入：

支持的专属参数：pageindex（插入位置，0表示插到第一页前）。

示例：

{"action":"blankpageinsert","url":["https://xxx/xxx.pdf"],"pageindex":2}

会在第2页后插入1个同尺寸空白页。

• 自动删除空白页：

专属参数：无。

示例：

{"action":"removeblankpages","url":["https://xxx/xxx.pdf"]}

会自动识别接近纯白的页面并删除，适合扫描件里的空白隔页清理。

• 页面旋转：

支持的专属参数：pagerotateangle（旋转角度）、pageindexes（可选，按原PDF页序筛选指定页面）。

示例：

{"action":"pagerotate","url":["https://xxx/xxx.pdf"],"pagerotateangle":90,"pageindexes":"2,4-6"}

会把PDF整本或指定页面按给定角度旋转；若传入 3,1，会旋转第1页和第3页，但不会重排页面。

• PDF裁边：

支持的专属参数：pageindexes、data.left、data.right、data.top、data.bottom。

示例：

{"action":"pdfcrop","url":["https://xxx/xxx.pdf"],"pageindexes":"2-10","data":{"left":18,"right":18,"top":24,"bottom":24}}

会按统一边距修改选中页面的CropBox，并输出新的pdfurl。pageindexes 仅用于筛选要裁边的页面，不会因为输入顺序而重排页面。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12,"pdfurl":"https://file.duhuitech.com/o/xxx/crop.pdf","data":{"uniform":true,"pages":[{"page":1,"width":559.28,"height":805.89,"orientation":"portrait"}]}}}

• PDF页数查询：

专属参数：无。

示例：

{"action":"pagecountinfo","url":["https://xxx/xxx.pdf"]}

会只查询PDF页数。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":12}}

• PDF页面信息：

支持的专属参数：pageindexes（可选；不传返回全部页面，传则按原PDF页序返回指定页）。

示例：

{"action":"pageinfo","url":["https://xxx/xxx.pdf"],"pageindexes":"1,3-4"}

会返回每一页的宽高和横竖版信息；若传入 3,1，返回结果仍按第1页、第3页的原PDF页序排列。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"data":{"uniform":false,"pages":[{"page":1,"width":595.28,"height":841.89,"orientation":"portrait"},{"page":3,"width":841.89,"height":595.28,"orientation":"landscape"},{"page":4,"width":595.28,"height":595.28,"orientation":"square"}]}}}

内容提取与结构

• 提取图片：

专属参数：无。

示例：

{"action":"extractimg","url":["https://xxx/xxx.pdf"]}

会把PDF里的图片提取出来。

pdffilename 不支持；导出的图片文件会按 1.png、2.png 这类顺序命名。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":2,"imageurls":["https://file.duhuitech.com/o/xxx/1.png","https://file.duhuitech.com/o/xxx/2.png"]}}

• PDF文本提取：

支持的专属参数：pageindexes、outfilename、data.textwithformat、data.textperpage。

示例：

{"action":"extracttext","url":["https://xxx/xxx.pdf"],"pageindexes":"1-3","outfilename":"chapter1","data":{"textwithformat":1,"textperpage":1}}

会提取PDF文字内容；默认输出一个txt文件，textperpage 为1时输出按筛选后页序分拆的zip文件。

pdffilename 不适用，请使用 outfilename 控制输出文件名前缀。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","count":3,"filesize":2048,"fileurl":"https://file.duhuitech.com/o/xxx/chapter1.zip"}}

• PDF元数据读取/修改：

支持的专属参数：meta.title、meta.author、meta.subject、meta.keywords、meta.creator、meta.producer。

示例：

{"action":"pdfmeta","url":["https://xxx/xxx.pdf"],"meta":{"title":"Quarterly Report","author":"Duhui"}}

不传 meta 时会读取当前PDF的常用元数据；传 meta 时会更新对应字段并返回新的pdfurl和更新后的data。

读取模式下 pdffilename 不适用；写入模式下支持 pdffilename。

返回结果重点字段：

返回结果示例（读取）：

{"result":{"status":"done","count":12,"data":{"title":"Quarterly Report","author":"Duhui","creator":"Word","producer":"Skia/PDF m123"}}}

更新模式下，返回结果会额外包含 result.pdfurl。

• PDF目录导出：

专属参数：无。

示例：

{"action":"outlineexport","url":["https://xxx/xxx.pdf"]}

会读取PDF目录书签。

pdffilename 不适用。

返回结果重点字段：

目录节点还可能包含 dest_name、color、flags、count、is_open 等可选字段。

返回结果示例：

{"result":{"status":"done","count":12,"data":{"named_dests":{},"outline":[{"title":"Chapter 1","dest":{"page_index":0,"dest":["/Fit"]},"kids":[{"title":"Section 1.1","dest":{"page_index":1,"dest":["/Fit"]}}]}]}}}

• PDF目录导入：

支持的专属参数：data（目录 JSON 对象，建议先调用 outlineexport 获取后原样传回）。

示例：

{"action":"outlineimport","url":["https://xxx/xxx.pdf"],"data":{"named_dests":{},"outline":[{"title":"Chapter 1","dest":{"page_index":0,"dest":["/Fit"]}}]}}

会把目录JSON写回PDF，并输出新的pdfurl。data 顶层应包含 named_dests 和 outline；其中 page_index 从 0 开始计数。

安全与权限

• 文件加密：

支持的专属参数：userpassword、ownerpassword、pdfrestriction。

示例：

{"action":"encrypt","url":["https://xxx/xxx.pdf"],"userpassword":"YOUR_PASSWORD","ownerpassword":"YOUR_PASSWORD","pdfrestriction":"110"}

userpassword 和 ownerpassword 至少传一个。该操作会给PDF加密码和权限限制。

• 文件解密（文件加密转换接口中已有）：

支持的专属参数：password（解密密码，可以为空）。

示例：

{"action":"decrypt","url":["https://xxx/xxx.pdf"],"password":""}

会把PDF解密。

• 文件是否加密：

专属参数：无。

示例：

{"action":"checkencrypt","url":["https://xxx/xxx.pdf"]}

会检查PDF是否加密。

pdffilename 不适用。

返回结果重点字段：

返回结果示例：

{"result":{"status":"done","data":{"encrypted":true}}}

通用请求参数BODY（JSON）:

其余参数均为 action 专属参数，见对应 action 小节。

请求示例：

http://all2pdf.apistore.huaweicloud.com/v1/pdfaction

传入的Body为JSON格式，见上方详细操作。

必须签名才能调用成功，签名见华为签名规则：

https://support.huaweicloud.com/usermanual-apig/apig-ug-0011.html

返回数据结构:

result:

异步任务完成后的通用说明：

• 所有 action 都支持 callbackurl。
• 大多数生成 PDF 的 action 都支持 pdffilename；任务完成后，可在 查询结果 或回调结果里看到 result.pdfurl、result.count，通常还会返回 result.filesize。
• 特殊 action 的最终返回字段见对应 action 小节，例如：split 返回 result.pdfurls，extractimg 返回 result.imageurls，extracttext 返回 result.fileurl，pagecountinfo、pageinfo、outlineexport、checkencrypt 等返回结构化数据。

返回示例(成功状态):

{
	"code":10000,
	"msg":"",
	"result":{"token":"YOUR_CREDENTIAL"}
}

返回示例(失败状态):

{
	"code":40001,
	"msg":"ParmNotRight"
}

查询 QUERY

请求参数：

请求示例：

https://api.duhuitech.com/q?token=YOUR_TOKEN

无需签名，无调用次数限制

由于转换需要时间，文件越大页数越多，转换越久，故需要轮询查询接口来获得结果。查询频率可以是1s一次，也可以更长一些。查询后先看status，如果是Done或Failed，则转换结束，停止轮询。如果是Doing或Pending，则继续轮询。

返回数据结构：

result:

返回示例(成功状态)：

{
    "code":10000,
    "msg":"",
    "token":"YOUR_CREDENTIAL",
    "result":
    {
        "progress":0.02,
        "status":"Doing"
    }
}

{
    "code":10000,
    "msg":"",
    "token":"YOUR_CREDENTIAL",
    "result":
    {
        "status":"Done",
        "pdfurl":"https://file.duhuitech.com/o/xxx/xxx.pdf",
        "count":10
    }
}

返回示例(失败状态)：

{
    "code":40000,
    "msg":"No such token"
}

注意：

• 上传文件大小不能超过1500M。
• 最大转换时长：1小时，超过时间未完成则自动失败。
• 转换完成后，下载链接有效时间：1小时。

上述最后2项有延长需求请联系客服：

回调URL：

用途：客户可以自行部署服务器，系统转换结束后会调用客户提供的回调URL，直接发送转换结果，从而无需再轮询Query。

当设置了回调URL，转换结束后（无论成功失败），系统都会尝试调用该URL，具体如下：

以POST方式调用该URL，Header头中Content-Type: application/json

Body为JSON格式，内容和Query的结果相同，例如：

{"code":10000,"msg":"","token":"YOUR_CREDENTIAL","result":{"status":"Done","pdfurl":"https://file.duhuitech.com/o/xxx/xxx.pdf","count":10}}

服务端收到该POST后需在10秒内返回HTTP STATUS CODE 200，视为调用成功，否则系统认为回调失败，会再次尝试。规则如下：

系统共计最多会调用3次回调URL，如果第一次失败，则等待3秒后尝试第二次，如果第二次失败，则等待5秒后尝试第三次，如果第三次失败，则不再尝试。

回调URL超时时间10秒。

---

关于下载转换后的文件需支持302跳转

接口返回的下载地址（如 fileurl / fileurls）会经 HTTP 302 跳转到实际文件。浏览器会自动跟随。

以下方式默认会跟随跳转，一般无需额外配置：

wget、Python requests / urllib、Node.js axios / got / fetch、Java OkHttp / HttpURLConnection、Go net/http、C# HttpClient、PHP file_get_contents、Objective-C / Swift NSURLSession / URLSession（含 Alamofire）

少数默认不跟随，需手动打开：

• curl：加 -L，如 curl -L -o out.bin "下载地址"
• Java java.net.http.HttpClient：设置 .followRedirects(HttpClient.Redirect.NORMAL)
• PHP curl 扩展：设置 CURLOPT_FOLLOWLOCATION => true

若只拿到 302 响应、本地没有文件内容，多半是未跟随跳转，按上面说明打开对应选项即可。

---

错误码表：