文档首页/数据安全中心 DSC/API参考（阿布扎比区域）/API说明/文档水印/文档嵌入水印
更新时间：2022-12-29 GMT+08:00
查看PDF
分享

文档嵌入水印

功能介绍

对WORD(.docx)，PPT(.pptx)，EXCEL(.xlsx)，PDF(.pdf) 类型的文件嵌入文字暗水印、文字明水印或者图片明水印，用户以formData的格式传入待加水印的文件和水印相关信息，DSC服务给文件加完水印后返回给用户已嵌入水印的文件的二进制流。

URI

POST /v1/{project_id}/sdg/doc/watermark/embed

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务“获取用户Token接口”获取（响应消息头中X-Subject-Token的值）

表3 FormData参数

参数

是否必选

参数类型

描述

doc_type

是

String

要嵌入水印的文档类型

枚举值：

  • WORD

  • EXCEL

  • PDF

  • PPT

file_password

否

String

输入文件有密码时，读取文件的密码， 最大支持长度256。如果Office文档有读密码或域控的权限密码，请输入读密码，或者有读权限的域控密码。

marked_file_password

否

String

添加水印后给文件设置密码， 最大支持长度256。默认不加文档密码。

readonly_password

否

String

添加水印后给文件设置只读密码， 最大支持长度256。默认不加只读密码。

visible_watermark

否

String

明水印内容，与“blind_watermark”字段至少有一个不为空

font_size

否

String

明水印字体大小，取值为[1,100]，默认值50

rotation

否

String

明水印旋转角度，逆时针方向，取值为[0,90]，默认值45

opacity

否

String

明水印的透明度，取值[0,1]，默认值为0.3；

blind_watermark

否

String

暗水印内容，与“visible_watermark”字段至少有一个不为空

file

是

File

要添加水印的文档

image_mark

否

File

图形水印的字节流。图形文件的格式必须为“png”或“jpg”，否则返回参数错误；图像文件大小不超过1MB；在分段的请求体“Content-Disposition”部分，参数“name”的值必须为“image_mark”。

visible_type

否

String

该字段为空时，默认为TEXT类型。

当该字段为IMAGE时:

  • 请求的表单中必须包含名为“image”的图像文件，图像格式必须为“png”或“jpg”，否则返回参数错误；

  • 图像文件大小不超过1MB；

  • “visible_watermark”，“font_size”，“rotation”和“opacity”字段无效。

枚举值：

  • TEXT

  • IMAGE

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

通过form表单提交请求，其中file是具体文件。

POST /v1/{project_id}/sdg/doc/watermark/embed

{
  "file" : "test.doc",
  "doc_type" : "WORD",
  "opacity" : "0.1",
  "font_size" : "30",
  "rotation" : "45",
  "blind_watermark" : "blind_watermark",
  "visible_watermark" : "visible_watermark"
}

响应示例

状态码： 200

请求成功

"{\"Watermarked document\"}"

状态码： 400

无效请求

{
  "error_code" : "DSC.00000007 ",
  "error_msg" : "File format error"
}

状态码

状态码

描述

200

请求成功

400

无效请求

错误码

请参见错误码。

父主题：文档水印