You need to enable JavaScript to run this app.
导航

接口文档

最近更新时间2021.06.30 11:19:11

首次发布时间2021.02.23 10:42:12

接入指引

请先查看接入指引了解具体接入方式,再参考此文档完成接入。

请求API

名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
图片要求1.图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式
2.图片文件大小:最大5MB

输入参数

Query参数:

参数可选/必选类型说明
Action必选String接口名,取值:ImageCut
Version必选String版本号,取值:2020-08-26

Body参数:

参数可选/必选类型说明
image_base64必选(imageimage_base64必选其一)String图片Base64编码
width必选Int要求输出图片的宽度
height必选Int要求输出图片的高度
cut_method必选String图片裁剪方法

cut_method 裁剪算法,现支持:

  1. gauss_padding_reserve_score: 高斯模糊兜底,会根据图片中主体大小进行扩展

  2. fix_size: 固定长宽比裁剪,不进行补边

  3. fix_size_pad_cut_text: 其他效果同上fix_size,但裁断比较大的文字时,会采用补边策略

  4. gauss_padding: 高斯模糊兜底

  5. gauss_padding_resize: 高斯模糊兜底,缩放到需求的长宽值

  6. only_gauss_pad: 只进行高斯模糊补边,不进行裁剪

  7. fix_size_color_quantization_when_cut_text: 智能裁剪,如果裁断文字,则选择用背景色补边

  8. remove_edge: 去除黑边高斯模糊边(width和height填成1,不会实际生效)

API返回(通用字段见通用返回字段及错误码

data字段说明

字段类型说明
imageImage裁剪后的图片
boundingboxBoundingBox裁剪框

Image结构说明

字段类型说明
urlString图片链接
dataString图片的base64编码

BoundingBox结构说明

字段类型说明
x_minfloat检测框x轴坐标(0~1)
x_maxfloat检测框x轴坐标(0~1)
y_minfloat检测框y轴坐标(0~1)
y_maxfloat检测框y轴坐标(0~1)

错误码(通用错误码见通用返回字段及错误码

HttpCode错误码错误消息描述
20010000请求成功

返回值示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "1.11217161s",
    "request_id": "68970913035200778321605854208",
    "message": "Success",
    "data": {
        "boundingbox": {
            "x_min": 0.43375,
            "y_max": 1,
            "y_min": 0,
            "x_max": 0.9325
        },
        "image": {
            "url": "{图片url}",
            "data": {图片base64编码}
        }
    }
}