接口描述
批量文件添加数字水印,一份文件一次仅可添加一种样式的数字水印,建议文件中不要存在大量图片,因数字水印图片默认放在文件图片下方,使用数字水印APP扫描时,图片区域会看不到水印信息。 (如数字水印图片放在图片上方,则文件打印后,图片上方会显示出数字水印图片,起不到防伪作用,因此默认放在文件图片下方),打印时必须彩打,对硬件的要求:彩色打印机精度越高越好,推荐最高分辨率1200*1200dpi以上;纸张质量越好,效果越好;彩色打印机墨盒尽可能保证原墨;打印时,选项中必须勾选”打印背景和图像”。
自2021年7月6日起,【文件添加数字水印】接口不再允许新开发者集成调用。
接口地址&请求方式
接口地址:/v1/files/batchAddWatermark
请求方式:POST
请求头格式
具体请求头格式结构,请点击查看公共参数说明。
请求参数
展开全部参数参数名称 | 类型 | 必选 | 参数类型 | 参数说明 (左右拖动查看完整描述) | ||
files | array | 是 | body | 文件信息开始 | ||
fileId | string | 是 | body | 文件id | ||
watermarkInfo | object | 是 | body | 水印信息 | ||
contentType | int | 是 | body | 1:原图fileId ; 2:原图base64; 3:文字 | ||
content | string | 是 | body | 水印内容:原图fileId/原图base64/文字, 1:文字最高32个字符;2:当传入内容为图片时,建议不超过200K,图片越大,添加时间越长; | ||
fontSize | int | 否 | body | 当content传入的是文字时,可指定文字大小,范围10-50号, 默认40 | ||
fontName | string | 否 | body | 当content传入的是文字时,可指定字体,支持如下字体,黑体 simhei 、普惠体 puhuiti、 宋体 simsun,默认黑体 | ||
imageHeight | int | 否 | body | 当content传入的是文字时,可以指定生成的水印图片固定高,300-600,默认根据文字大小自适应水印图片高 | ||
imageWidth | int | 否 | body | 当content传入的是文字时,可以指定生成的水印图片固定宽,300-600,默认根据文字大小自适应水印图片宽 | ||
rotationAngle | int | 否 | body | 当content传入的是文字时,可指定生成的水印图片旋转角度 ,正数为顺时针旋转,负数为逆时针旋转 | ||
scaling | int | 否 | body | 当content传入的是图片时,可以缩放生成的水印图片比例, 默认是100%,原尺寸大小 | ||
vmModel | int | 否 | body | 生成的水印图片渲染模式: 1描边 、2实心 ,默认实心, 当content传入的是文字时,字体推荐:黑体、宋体 | ||
lineWidths | int | 否 | body | 生成的水印图片在描边模式下,选择描边的粗细。范围为1~4,默认为3 | ||
alpha | int | 否 | body | 生成的水印图片透明度,1-255 值越大,打印出的文件越容易肉眼辨识水印图片,默认135 | ||
strength | int | 否 | body | 生成的水印图片强度,240-253 ,值越大,打印出的文件越难肉眼辨识水印图片,默认240 | ||
posBean | object | 否 | body | 水印图片位置信息(不传默认所有页平铺,传posPage不传x,y在指定页平铺,传x,y指定位置) | ||
posPage | string | 否 | body | 页码信息,默认全部文件,可以','或'-'分割 | ||
posX | float | 否 | body | 默认平铺全部 | ||
posY | float | 否 | body | 默认平铺全部 | ||
notifyUrl | string | 否 | body | 水印图片全部添加完成回调地址 | ||
thirdOrderNo | string | 否 | body | 三方流水号(唯一),有回调必填 |
响应参数
参数名称 | 类型 | 必选 | 参数说明 (左右拖动查看完整描述) |
code | int | 是 | 业务码,0表示成功 |
message | string | 否 | 业务信息 |
data | object | 否 | 业务数据 |
请求示例
POST https://openapi.esign.cn/v1/files/batchAddWatermark
{ "files": [ { "fileId": "", "watermarkInfo": { "contentType": 3, "content": "水印文字", "fontSize": 40, "fontName": "simhei", "vmModel": 2, "lineWidths": 3, "alpha": 135, "strength": 240, "scaling": 100 } } ], "notifyUrl": "", "thirdOrderNo": "" }
响应示例
无