PDF 文档对比 API

BASE URLhttps://api-server.compdf.com/server/

❖ 功能说明

对比两个 PDF 文件的内容差异。

❖ 调用方式

同步请求 (Sync) ✓

接口完成后直接返回结果文件。推荐在小文件、前端实时交互等需要即时反馈的场景下使用。

异步请求 (Async)

先返回任务受理结果，再通过 taskId 查询处理进度和结果。适用于大文件及批量执行任务。

预签名请求方式

通过预签名等安全机制上传处理，适用于高安全性要求及数据隐私合规场景。

▎调用流程

1上传文件

2调用接口（同步）

3获取结果地址

4下载文件

▎使用限制

下载有效期

24 小时

同步执行

POSThttps://api-server.compdf.com/server/v2/process/pdf/contentCompare

❖ 请求参数 (Parameters)

x-api-key*

在 Header 中发送的 x-api-key 认证凭证

Body Parameters multipart/form-data

fileFile*

选择文件未选择文件

上传文件

passwordstring

文件密码（如果 PDF 有密码保护）

languageinteger

接口错误提示语言（1=English，2=中文）

modestring*

对比模式：content 或 overlay

basePasswordstring

基准 PDF 密码

comparePasswordstring

对比 PDF 密码

replaceColorstring

定义替换内容的颜色（默认值为 #93B9FD）。

insertColorstring

定义插入内容的颜色（默认值为 #C0FFEC）。

overlayBaseColorstring

overlay 模式下基准色

overlayCompareColorstring

overlay 模式下对比色

fillAlphaBaseinteger

overlay 模式下基准透明度 0-100

fillAlphaCompareinteger

overlay 模式下对比透明度 0-100

outputFileNamestring

输出文件名

❖ 响应属性说明

字段	类型	说明
code	String	业务状态码
msg	String	返回信息
data	Array	响应数据
data[].fileKey	String	文件在存储系统中的唯一 key。
data[].taskId	String	任务 ID。创建任务后返回，后续启动转换或查询任务状态时使用。
data[].fileName	String	源文件名称。预签名模式必填，用于生成对象存储上传地址。
data[].downFileName	String	转换完成后的输出文件名。
data[].fileUrl	String	源文件存储地址或对象存储 key。
data[].downloadUrl	String	文件下载地址
data[].sourceType	String	源文件类型或源功能分类，例如 pdf、docx、img、documentAI、idp。
data[].targetType	String	目标文件类型或目标功能，例如 docx、pdf、split、ocr。
data[].fileSize	Integer	源文件大小，单位为字节。
data[].convertSize	Integer	转换结果文件大小，单位为字节。
data[].convertTime	Integer	单个文件转换耗时，单位通常为毫秒。
data[].status	String	文件处理状态。常见值包括 success、failed、processing 等。
data[].failureCode	String	文件转换失败时的错误码。
data[].failureReason	String	文件转换失败时的错误原因。
data[].fileParameter	String	创建任务时提交的转档参数 JSON 字符串。

🔗请求示例 (Request)

curl --request POST \
  --url https://api-server.compdf.com/server/v2/process/pdf/contentCompare \
  --header 'x-api-key: YOUR API-KEY' \
  --form [email protected]

✓响应示例 (Response)

200 OK

{
  "code": "200",
  "msg": "success",
  "data": [
    {
      "fileKey": "<string>",
      "taskId": "<string>",
      "fileName": "<string>",
      "downFileName": "<string>",
      "fileUrl": "<string>",
      "downloadUrl": "<string>",
      "sourceType": "<string>",
      "targetType": "<string>",
      "fileSize": 0,
      "convertSize": 0,
      "convertTime": 0,
      "status": "<string>",
      "failureCode": "<string>",
      "failureReason": "<string>",
      "fileParameter": "<string>"
    }
  ]
}