Skip to content

PDF合并工具使用指南

注意:在学习使用不同函数之前,建议先阅读请求描述,了解基本的PDF处理流程。使用不同函数时,可以在上传文件时设置各自特殊的参数。其他基本步骤一致。

PDF合并:

-在同一个任务中,上传多个文件(最多5个),若不传入pageOptions,则为多文件合并。

-在同一个任务中,上传多个文件(最多5个),pageOptions,合并指定页码的多个文件。

java
{
    "pageOptions": "['1,2']"
}

所需参数

pageOptions:合并文档的页面范围,页码从1开始,例如:1,2,4,6,9-11(如果默认不输入所有页面,则输入的页码不能超过文档的最大页码)

请求示例:

您需要将 apiKey 替换为您从控制台获取的 publicKey,将 file 替换为您要转换的文件 ,language 替换为您想要的接口错误提示语言类型。

curl
curl --location --request POST 'https://api-server.compdf.com/server/v2/process/pdf/merge' \
--header 'x-api-key: apiKey' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--header 'Content-Type: multipart/form-data' \
--form 'file=@"file1"' \
--form 'file=@"file2"' \
--form 'password="" \
--form 'parameter="{ \"pageOptions\": \"['1,2']\" }"' \
--form 'language="1"'
java
import java.io.*;
import okhttp3.*;

public class Main {
    public static void main(String[] args) throws IOException {
        List<File> filesToUpload = List.of(
            new File("file1.pdf"),
            new File("file2.pdf"),
            new File("file3.pdf")
        );
        OkHttpClient client = new OkHttpClient().newBuilder().build();
        MultipartBody.Builder bodyBuilder = new MultipartBody.Builder()
            .setType(MultipartBody.FORM)
            .addFormDataPart("language", "{{language}}")
            .addFormDataPart("password", "")
            .addFormDataPart("parameter", "{\"pageOptions\": \"['1,2']\"}");

        for (File file : filesToUpload) {
            bodyBuilder.addFormDataPart(
                "file", 
                file.getName(),
                RequestBody.create(
                    MediaType.parse("application/octet-stream"),  
                    file
                )
            );
        }
        Request request = new Request.Builder()
            .url("https://api-server.compdf.com/server/v2/process/pdf/merge")
            .method("POST", bodyBuilder.build())
            .addHeader("x-api-key", "{{apiKey}}")
            .build();
        Response response = client.newCall(request).execute();
    }
}

响应信息:

请求的成功响应返回 HTTP 200 OK 状态代码以及显示订单详细信息的 JSON 响应主体。

响应模式:application/json

响应参数数据类型描述
codeStringHTTP请求状态,"200"代表成功
messageString请求信息
dataObject返回结果
+taskIdString任务ID
+taskFileNumint任务处理文件数量
+taskSuccessNumint任务处理文件成功数量
+taskFailNumint任务处理文件失败数量
+taskStatusString任务状态
+assetTypeIdint使用资产类型ID
+taskCostint任务费用
+taskTimeint任务持续时间
+sourceTypeString原格式
+targetTypeString目标格式
+fileInfoDTOListArray任务文件信息
++fileKeyString文件key
++taskIdString任务ID
++fileNameString原文件名
++downFileNameString下载文件名
++fileUrlString原文件地址
++downloadUrlString处理结果文件下载地址
++sourceTypeString原格式
++targetTypeString目标格式
++fileSizeint文件大小
++convertSizeint处理结果文件大小
++convertTimeint处理消耗时间
++statusString文件处理状态
++failureCodeString文件处理失败错误码
++failureReasonString文件处理失败说明
++fileParameterString处理参数

响应示例:

json
"code": "200",
"msg": "success",
"data": {
    "taskId": "f416dbcf-0c10-4f93-ab9e-a835c1f5dba1",
    "taskFileNum": 1,
    "taskSuccessNum": 1,
    "taskFailNum": 0,
    "taskStatus": "<taskStatus>",
    "assetTypeId": 0,
    "taskCost": 1,
    "taskTime": 1,
    "sourceType": "<sourceType>",
    "targetType": "<targetType>",
    "fileInfoDTOList": [
      {
        "fileKey": "<fileKey>",
        "taskId": "<taskId>",
        "fileName": "<fileName>",
        "downFileName": "<downFileName>",
        "fileUrl": "<fileUrl>",
        "downloadUrl": "<downloadUrl>",
        "sourceType": "<sourceType>",
        "targetType": "<targetType>",
        "fileSize": 24475,
        "convertSize": 6922,
        "convertTime": 8,
        "status": "<status>",
        "failureCode": "",
        "failureReason": "",
        "fileParameter": "<fileParameter>"
      }
    ]
}

结果:

文件类型说明
.pdf合并后的 PDF 文件

异步请求

如果您需要使用文件异步处理流程,请阅读异步请求说明