裁剪图像
图像 → 裁剪图像
这 裁剪图像 API 按边框或矩形裁剪图像。您发送的图像格式为： Base64 （docContent）， docName， CropType （边框或矩形），对于边框： LeftBorder， RightBorder， TopBorder， BottomBorder；对于矩形： UpperLeftX， UpperLeftY， Width， Height（可选） async。 这 API 返回裁剪后的图像。使用下面的测试工具进行尝试；更多详情请参见后续章节。
尝试裁剪图像 API
:::备注 快速参考
终点： POST /api/v2/CropImage · 必需的： api-key， docContent， docName， CropType
:::
在线体验
使用下方表格提交您的 API 键和图像（Base64选择边框或矩形并设置尺寸；返回裁剪后的图像。无需编写代码，只需填写字段并点击即可。 发送请求.
Loading API Tester...
概述、参数和用例
- Overview
- Parameters
- Use cases
什么是图像裁剪？
此接口用于裁剪图像。您需要提供图像（Base64）， docName， 和 CropType： 边界 （LeftBorder， RightBorder， TopBorder， BottomBorder （以像素为单位）或 长方形 （UpperLeftX， UpperLeftY， Width， Height （以像素为单位）。 API 返回裁剪后的图像。
主要特点
- 边界：通过指定左、右、上、下边界值（以像素为单位）进行裁剪。
- 长方形：通过指定左上角 (X, Y) 和宽度/高度（以像素为单位）进行裁剪。
- 格式已支持： JPG， PNG， GIF， BMP， TIFF。
:::提示 最佳用途
当需要移除边框或提取区域时使用。可与以下工具结合使用。 调整图像大小 或者 压缩图像 在管道中。
:::
API 参数
| 范围 | 类型 | 必需的 | 描述 |
|---|---|---|---|
| api-key | 细绳 | 是的 | 你的 PDF4me API 钥匙， Base64 已编码。从……获取 仪表板。 |
| docContent | base64 | 是的 | 图像文件内容（Base64已支持： JPG， PNG， GIF， BMP， TIFF。 |
| docName | 细绳 | 是的 | 输出图像文件名。 |
| CropType | 细绳 | 是的 | 边界 或者 长方形。 |
| LeftBorder， RightBorder， TopBorder， BottomBorder | 细绳 | 不 | 边框裁剪值（以像素为单位）（用于边框）。 |
| UpperLeftX， UpperLeftY， Width， Height | 整数 | 不 | 矩形裁剪（适用于矩形）。 |
| async | 布尔值 | 不 | 启用异步处理。 |
先决条件
使用此端点之前，请确保您已具备以下条件：
- 有效的 PDF4me API 钥匙 （获得你的 API 钥匙）
- 图像文件（JPG， PNG， GIF， BMP， TIFF） 在 Base64 格式
回复格式
这 API 返回应用指定裁剪区域后的图像文件。