图片操作

💡 调用API，需要认证。认证参考【接口认证】

POST {apiPrefix}/image/transform

提交转换任务

任务添加失败，同步返回失败原因
任务添加成功，同步返回任务ID。第三方可以通过调用状态查询请求或者配置任务回调通知获取任务状态。

请求体

Content-Type为application/json

参数名	类型	说明	是否必须
fileUrl	string	文件下载地址	是
filename	string	包含后缀的文件名	是
tokenType	string	三方token类型，值为cookie或者header	否
tokenValue	string	三方token值，zOffice下载文件或回调通知时回传	否
callback	string	回调地址。任务转换结束后zOffice回调通知状态	是
imageOptions	object	图片操作相关选项	是
tiledWatermark	object	平铺水印平铺水印为图片时，其中rotation 旋转角度参数值选项为（90,180,270）按照给定的旋转角度传入	否
textWatermark	object	文字水印	否
msPicWatermark	object	图片水印其中rotation 旋转角度参数值选项为（90,180,270）按照给定的旋转角度传入	否

类型暂支持JPG、JPEG、PNG、BMP，图片大小最大不能超过50m
上述通用参数（除imageOptions、tiledWatermark、textWatermark、msPicWatermark外）说明见本文档【通用字段说明】
水印三种参数只会选用一种水印优先级 (平铺水印>文字水印>图片水印)
tiledWatermark 参数说明见本文档【类型/TiledWatermark】
textWatermark 参数说明见本文档【类型/TextWatermark】
msPicWatermark 参数说明见文档【类型/MsPicWatermark】

imageOptions 参数说明

参数名	类型	说明	是否必须
scale	number	给定百分比（0-200）（默认 0 不缩放,200表示放大为原来的200%，小于100表示按百分比缩小，大于100表示按百分比放大），高度和宽度均按指定百分比缩放`优先级（scale > width > height)`	否
width	number	给定宽度（0-2000）（px），按宽度等比缩放 `优先级（scale > width > height)`	否
height	number	给定高度（0-2000）（px），按高度等比缩放 `优先级（scale > width > height)`	否
rotate	number	图片旋转角度（90,180,270）按照给定的旋转角度旋转图片	否
quality	number	图片质量（0-100）压缩图片质量，只能修改JPG/JPEG图片质量	否
horizontalFlip	boolean	水平镜像翻转	否
verticalFlip	boolean	垂直镜像翻转	否

请求示例

整体缩小为原来的50%，并旋转90度

{
    "fileUrl": "源文件下载地址",
    "filename": "源文件名",
    "tokenType":"cookie",
    "tokenValue":"zdocs_access_token={{zdocs_access_token}}",
    "callback": "回调地址",
    "imageOptions":{ 
        "scale": 50,   
        "rotate": 90
    }
}

按照宽度500px等比缩放，并水平镜像翻转，后加平铺文字水印

{
    "fileUrl": "源文件下载地址",
    "filename": "源文件名",
    "tokenType":"cookie",
    "tokenValue":"zdocs_access_token={{zdocs_access_token}}",
    "callback": "回调地址",
    "imageOptions":{ 
        "width": 500,   
        "horizontalFlip": true
    },
    "tiledWatermark": { 
        "line1": "watermark for test", 
        "line2": "", 
        "line3": "", 
        "line4": "", 
        "withDate": true, 
        "fontcolor": "#cecece", 
        "transparent": 70, 
        "rotation": 315, 
        "fontsize": "30", 
        "font": "黑体", 
        "isFontBold": true,
        "isFontItalic": true,
        "spacing": 50 
    }
}

全部参数展示。以下的水印参数已全部展示，实际时选择一种就好

{
    "fileUrl": "源文件下载地址",
    "filename": "源文件名",
    "tokenType":"cookie",
    "tokenValue":"zdocs_access_token={{zdocs_access_token}}",
    "callback": "回调地址",
    "imageOptions":{
        "scale":100, 
        "width":0,  
        "height":0,
        "rotate":0, 
        "quality":0,  
        "horizontalFlip":false, 
        "verticalFlip":false,  
    },
    "tiledWatermark": { 
        "line1": "watermark for test", 
        "line2": "", 
        "line3": "", 
        "line4": "", 
        "picUrl": "图片链接", 
        "picName": "带后缀图片名", 
        "picScale": 50,
        "withDate": true, 
        "fontcolor": "#cecece", 
        "transparent": 70, 
        "rotation": 315, 
        "fontsize": "30", 
        "font": "黑体", 
        "isFontBold": true,
        "isFontItalic": true,
        "spacing": 50 
    },
    "textWatermark": {
        "text": "watermark for test",
        "fontcolor": "#DC134C",
        "fontsize": "40",
        "font": "黑体",
        "isFontBold": true,
        "isFontItalic": true,
        "rotation": 90,
        "transparent": 70,
        "position": "CENTER"
    },
    "msPicWatermark": {
        "picUrl": "图片链接",
        "picName": "带后缀图片名",
        "picScale": 50,
        "rotation": 90,
        "transparent": 70,
        "position": "CENTER"
    }
}

正常返回：

{
    "taskId": "6f6598c8-c87e-420b-b6c4-6f1b187201dc",
    "code": "Ok",
    "detail": {
        "taskStatus": "IN_QUEUE"
    }
}

错误返回：

{
    "taskId": "695fbf6e-90d2-42ba-83d5-00e81e5e366e",
    "code": "TaskQueueCongestion",
    "detail": {
        "taskStatus": "FAIL"
    }
}