API Libraries and Examples for Developers

更多功能

水印

添加文本水印

使用添加水印工具，您可以为 PDF 添加文本水印。以下示例展示了如何使用 Java、PHP、C#、Python 和 Swift 编程语言上传 PDF 文件并运行添加水印功能。然后，输出 PDF 文件。

Java

// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a PDF AddWatermark task
CPDFCreateTaskResult result = client.createTask(CPDFDocumentEditorEnum.ADD_WATERMARK);

// Get a task id
String taskId = result.getTaskId();

// File handling parameter settings
CPDFAddWatermarkParameter fileParameter = new CPDFAddWatermarkParameter();
fileParameter.setType("text");
fileParameter.setScale("1");
fileParameter.setOpacity("0.5");
fileParameter.setRotation("0.785");
fileParameter.setTargetPages("1-2");
fileParameter.setVertalign("center");
fileParameter.setHorizalign("left");
fileParameter.setXoffset("100");
fileParameter.setYoffset("100");
fileParameter.setContent("test");
fileParameter.setTextColor("#59c5bb");
fileParameter.setFullScreen("1");
fileParameter.setHorizontalSpace("10");
fileParameter.setVerticalSpace("10");

// Upload files
client.uploadFile(new File("test.pdf"), taskId, fileParameter);

// Execute task
client.executeTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);

PHP

// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF AddWatermark task
$taskInfo = $client->createTask(CPDFDocumentEditor::ADD_WATERMARK);

// File handling parameter settings
$file = $client->addFile('test.pdf')
    ->setType('text')
    ->setScale('1')
    ->setOpacity('0.5')
    ->setRotation('0.785')
    ->setTargetPages('1-2')
    ->setVertalign('center')
    ->setHorizalign('left')
    ->setXOffset('100')
    ->setYOffset('100')
    ->setContent('text')
    ->setTextColor('#59c5bb')
    ->setFullScreen('1')
    ->setHorizontalSpace('10')
    ->setVerticalSpace('10');

// Upload files
$fileInfo = $file->uploadFile($taskInfo['taskId']);

// Execute task
$client->executeTask($taskInfo['taskId']);

// Query TaskInfo
$taskInfo = $client->getTaskInfo($taskInfo['taskId']);

// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a PDF AddWatermark task
CPDFCreateTaskResult result = client.CreateTask(CPDFDocumentEditorEnum.ADD_WATERMARK);

// Get a task id
string taskId = result.TaskId;

// File handling parameter settings
CPDFAddWatermarkParameter fileParameter = new CPDFAddWatermarkParameter();
fileParameter.Type = "text";
fileParameter.Scale = "1";
fileParameter.Opacity = "0.5";
fileParameter.Rotation = "0.785";
fileParameter.TargetPages = "1-2";
fileParameter.Vertalign = "center";
fileParameter.Horizalign = "left";
fileParameter.Xoffset = "100";
fileParameter.Yoffset = "100";
fileParameter.Content = "test";
fileParameter.TextColor = "#59c5bb";
fileParameter.FullScreen = "1";
fileParameter.HorizontalSpace = "10";
fileParameter.VerticalSpace = "10";

// Upload files
client.UploadFile(new FileInfo("test.pdf"), taskId, fileParameter);

// Execute task
client.ExecuteTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.GetTaskInfo(taskId);

Python

# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a PDF AddWatermark task
create_task_result = client.create_task(CPDFDocumentEditorEnum.ADD_WATERMARK)

# taskId
task_id = create_task_result.task_id

# File handling parameter settings
file_parameter = CPDFAddWatermarkParameter()
file_parameter.type = "text"
file_parameter.scale = "1"
file_parameter.opacity = "0.5"
file_parameter.rotation = "0.785"
file_parameter.target_pages = "1-2"
file_parameter.vertalign = "center"
file_parameter.horizalign = "left"
file_parameter.xoffset = "100"
file_parameter.yoffset = "100"
file_parameter.content = "test"
file_parameter.text_color = "#59c5bb"
file_parameter.full_screen = "1"
file_parameter.horizontal_space = "10"
file_parameter.vertical_space = "10"

# upload File
upload_file_result = client.upload_file('test.pdf', task_id, file_parameter)

# Execute task
client.execute_task(task_id)

# get task processing information
task_info = client.get_task_info(task_id)

Swift

// Create a client
let client: CPDFClient = CPDFClient(publicKey: public_key, secretKey: secret_key)

Task { @MainActor in
    // Create a task
    // Create an example of a PDF AddWatermark task
    let taskModel = await client.createTask(url: CPDFDocumentEditor.ADD_WATERMARK)
    
    // Get a task id
    let taskId = taskModel?.taskId ?? ""

    // Upload file
    let path = Bundle.main.path(forResource: "test", ofType: "pdf")
    let uploadFileModel = await client.uploadFile(filepath: path ?? "", password: "", params: [
        CPDFFileUploadParameterKey.textColor.string():"#59c5bb",
        CPDFFileUploadParameterKey.type.string():"text",
        CPDFFileUploadParameterKey.content.string():"text",
        CPDFFileUploadParameterKey.scale.string():"1",
        CPDFFileUploadParameterKey.opacity.string():"0.5",
        CPDFFileUploadParameterKey.rotation.string():"0.785",
        CPDFFileUploadParameterKey.targetPages.string():"1-2",
        CPDFFileUploadParameterKey.vertalign.string():"center",
        CPDFFileUploadParameterKey.horizalign.string():"left",
        CPDFFileUploadParameterKey.xoffset.string():"100",
        CPDFFileUploadParameterKey.yoffset.string():"100",
        CPDFFileUploadParameterKey.fullScreen.string():"1",
        CPDFFileUploadParameterKey.horizontalSpace.string():"10",
        CPDFFileUploadParameterKey.verticalSpace.string():"10"
    ], taskId: taskId)
    
    // Execute task
    let _ = await client.processFiles(taskId: taskId)
    
    // Query TaskInfo
    let taskInfoModel = await client.getTaskInfo(taskId: taskId)
}

代码	说明
`type`	水印类型（text：文本类型水印，image：图片类型水印）。
`scale`	缩放（图片类型属性）。
`opacity`	透明度：0～1。
`rotation`	旋转角度：正数表示逆时针旋转。
`targetPages`	页码：页码应为大于1的正整数，从1开始，如：1,2,4,6,9-11。
`vertalign`	垂直对齐（top、center、bottom）。
`horizalign`	水平对齐（left、center、right）。
`xoffset`	水平偏移。
`yoffset`	垂直偏移。
`content`	文本。
`textColor`	文本颜色，如#FFFFFF。
`front`	显示在最前面。
`fullScreen`	是否填充整个页面。
`horizontalSpace`	水平间距（仅当 — fullscreen 存在时才支持）默认值 50。
`verticalSpace`	垂直间距（仅当 — fullscreen 存在时才支持）默认值 50。
`extension`	扩展信息，base64 编码。

结果：

文件类型	说明
.pdf	添加水印后的 PDF 文件。

添加图片水印

使用添加水印工具，您可以为 PDF 添加图片水印。以下示例展示如何使用 Java、PHP、C#、Python 和 Swift 编程语言上传 PDF 文件并运行添加水印功能。然后，输出 PDF 文件。

Java

// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a PDF AddWatermark task
CPDFCreateTaskResult result = client.createTask(CPDFDocumentEditorEnum.ADD_WATERMARK);

// Get a task id
String taskId = result.getTaskId();

// File handling parameter settings
CPDFAddWatermarkParameter fileParameter = new CPDFAddWatermarkParameter();
fileParameter.setType("image");
fileParameter.setScale("0.5");
fileParameter.setOpacity("0.5");
fileParameter.setRotation("45");
fileParameter.setTargetPages("1-2");
fileParameter.setVertalign("center");
fileParameter.setHorizalign("left");
fileParameter.setXoffset("50");
fileParameter.setYoffset("50");
fileParameter.setFullScreen("1");
fileParameter.setHorizontalSpace("100");
fileParameter.setVerticalSpace("100");
fileParameter.setFront("1");

// Upload files
client.uploadFile(new File("test.pdf"), taskId, fileParameter,new File("sample/test.jpg"));

// Execute Task
client.executeTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);

PHP

// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF AddWatermark task
$taskInfo = $client->createTask(CPDFDocumentEditor::ADD_WATERMARK);

// File handling parameter settings
$file = $client->addFile('test.pdf')
    ->setType('image')
    //Set Watermark Image
    ->setImagePath('test.jpg')
    ->setScale('0.5')
    ->setOpacity('0.5')
    ->setRotation('45')
    ->setTargetPages('1-2')
    ->setVertalign('center')
    ->setHorizalign('left')
    ->setXOffset('50')
    ->setYOffset('50')
    ->setFullScreen('1')
    ->setHorizontalSpace('100')
    ->setVerticalSpace('100')
    ->setFront('1');

// Upload files
$fileInfo = $file->uploadFile($taskInfo['taskId']);

// Execute task
$client->executeTask($taskInfo['taskId']);

// Query TaskInfo
$taskInfo = $client->getTaskInfo($taskInfo['taskId']);

// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a PDF AddWatermark task
CPDFCreateTaskResult result = client.CreateTask(CPDFDocumentEditorEnum.ADD_WATERMARK);

// Get a task id
string taskId = result.TaskId;

// File handling parameter settings
CPDFAddWatermarkParameter fileParameter = new CPDFAddWatermarkParameter();
fileParameter.Type = "image";
fileParameter.Scale = "0.5";
fileParameter.Opacity = "0.5";
fileParameter.Rotation = "45";
fileParameter.TargetPages = "1-2";
fileParameter.Vertalign = "center";
fileParameter.Horizalign = "left";
fileParameter.Xoffset = "50";
fileParameter.Yoffset = "50";
fileParameter.FullScreen = "1";
fileParameter.HorizontalSpace = "100";
fileParameter.VerticalSpace = "100";
fileParameter.Front = "1";

// Upload files
client.UploadFile(new FileInfo("test.pdf"), taskId, fileParameter,new FileInfo("sample/test.jpg"));

// Execute task
client.ExecuteTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.GetTaskInfo(taskId);

Python

# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a PDF AddWatermark task
create_task_result = client.create_task(CPDFDocumentEditorEnum.ADD_WATERMARK)

# taskId
task_id = create_task_result.task_id

# File handling parameter settings
file_parameter = CPDFAddWatermarkParameter()
file_parameter.type = "image"
file_parameter.scale = "0.5"
file_parameter.opacity = "0.5"
file_parameter.rotation = "45"
file_parameter.target_pages = "1-2"
file_parameter.vertalign = "center"
file_parameter.horizalign = "left"
file_parameter.xoffset = "50"
file_parameter.yoffset = "50"
file_parameter.full_screen = "1"
file_parameter.horizontal_space = "100"
file_parameter.vertical_space = "100"
fileParameter.Front = "1";

# Upload file
upload_file_result = client.upload_file('test.pdf', task_id, file_parameter, image="sample/test.jpg")

# Execute task
client.execute_task(task_id)

# get task processing information
task_info = client.get_task_info(task_id)

Swift

// Create a client
let client: CPDFClient = CPDFClient(publicKey: public_key, secretKey: secret_key)

Task { @MainActor in
    // Create a task
    // Create an example of a PDF AddWatermark task
    let taskModel = await client.createTask(url: CPDFDocumentEditor.ADD_WATERMARK)
    
    // Get a task id
    let taskId = taskModel?.taskId ?? ""

    // Upload file
    let path = Bundle.main.path(forResource: "test", ofType: "pdf")
    let uploadFileModel = await client.uploadFile(filepath: path ?? "", password: "", params: [
        CPDFFileUploadParameterKey.type.string():"image",
        CPDFFileUploadParameterKey.filepath.string() : Bundle.main.path(forResource: "test", ofType: "jpg")!,
        CPDFFileUploadParameterKey.scale.string():"0.5",
        CPDFFileUploadParameterKey.opacity.string():"0.5",
        CPDFFileUploadParameterKey.rotation.string():"45",
        CPDFFileUploadParameterKey.targetPages.string():"1-2",
        CPDFFileUploadParameterKey.vertalign.string():"center",
        CPDFFileUploadParameterKey.horizalign.string():"left",
        CPDFFileUploadParameterKey.xoffset.string():"50",
        CPDFFileUploadParameterKey.yoffset.string():"50",
        CPDFFileUploadParameterKey.fullScreen.string():"1",
        CPDFFileUploadParameterKey.horizontalSpace.string():"100",
        CPDFFileUploadParameterKey.verticalSpace.string():"100"
    ], taskId: taskId)
    
    // Execute task
    let _ = await client.processFiles(taskId: taskId)
    
    // Query TaskInfo
    let taskInfoModel = await client.getTaskInfo(taskId: taskId)
}

代码	说明
`type`	水印类型（text：文本类型水印，image：图片类型水印）。
`scale`	缩放（图片类型属性）。
`opacity`	透明度：0～1。
`rotation`	旋转角度：正数表示逆时针旋转。
`targetPages`	页码：页码应为大于1的正整数，从1开始，如：1,2,4,6,9-11。
`vertalign`	垂直对齐方式（上、中、下）。
`horizalign`	水平对齐方式（左、中、右）。
`xoffset`	水平偏移量。
`yoffset`	垂直偏移量。
`content`	文本。
`textColor`	文本颜色，如：#FFFFFF。
`front`	显示在最前面。
`fullScreen`	是否填充整个页面。
`horizontalSpace`	水平间距（仅当 --fullscreen 存在时才支持）默认值 50。
`verticalSpace`	垂直间距（仅当 --fullscreen 存在时才支持）默认值 50。
`extension`	扩展信息，base64编码。

结果：

文件类型	说明
.pdf	添加水印后的 PDF 文件。

删除水印

使用删除水印工具，您可以删除 PDF 中的水印。以下示例展示了如何使用 Java、PHP、C#、Python 和 Swift 编程语言上传 PDF 文件并运行删除水印功能。然后，输出 PDF 文件。

Java

// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a PDF DeleteWatermark task
CPDFCreateTaskResult result = client.createTask(CPDFDocumentEditorEnum.DEL_WATERMARK);

// Get a task id
String taskId = result.getTaskId();

// File handling parameter settings
CPDFDeleteWatermarkParameter fileParameter = new CPDFDeleteWatermarkParameter();

// Upload files
client.uploadFile(new File("test.pdf"), taskId, fileParameter);

// Execute task
client.executeTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);

PHP

// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF DeleteWatermark task
$taskInfo = $client->createTask(CPDFDocumentEditor::DEL_WATERMARK);

// Upload files
$fileInfo = $client->addFile('test.pdf')->uploadFile($taskInfo['taskId']);

// Execute task
$client->executeTask($taskInfo['taskId']);

// Query TaskInfo
$taskInfo = $client->getTaskInfo($taskInfo['taskId']);

// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a PDF DeleteWatermark task
CPDFCreateTaskResult result = client.CreateTask(CPDFDocumentEditorEnum.DEL_WATERMARK);

// Get a task id
string taskId = result.TaskId;

// File handling parameter settings
CPDFDeleteWatermarkParameter fileParameter = new CPDFDeleteWatermarkParameter();

// Upload files
client.UploadFile(new FileInfo("test.pdf"), taskId, fileParameter);

// Execute task
client.ExecuteTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.GetTaskInfo(taskId);

Python

# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a PDF DeleteWatermark task
create_task_result = client.create_task(CPDFDocumentEditorEnum.DEL_WATERMARK)

# taskId
task_id = create_task_result.task_id

# File handling parameter settings
file_parameter = CPDFDeleteWatermarkParameter()

# Upload file
upload_file_result = client.upload_file('test.pdf', task_id, file_parameter)

# Execute task
client.execute_task(task_id)

# get task processing information
task_info = client.get_task_info(task_id)

Swift

// Create a client
let client: CPDFClient = CPDFClient(publicKey: public_key, secretKey: secret_key)

Task { @MainActor in
    // Create a task
    // Create an example of a PDF DeleteWatermark task
    let taskModel = await client.createTask(url: CPDFDocumentEditor.DEL_WATERMARK)
    
    // Get a task id
    let taskId = taskModel?.taskId ?? ""

    // Upload file
    let path = Bundle.main.path(forResource: "test", ofType: "pdf")
    let uploadFileModel = await client.uploadFile(filepath: path ?? "", password: "" ,params: [:], taskId: taskId)
    
    // Execute task
    let _ = await client.processFiles(taskId: taskId)
    
    // Query TaskInfo
    let taskInfoModel = await client.getTaskInfo(taskId: taskId)
}

结果：

文件类型	说明
.pdf	删除水印后的 PDF 文件。

更多功能 ​

水印 ​

更多功能

水印