// 开发者 / API DOCS

开发者 API 文档

与网页版共用同一套后端接口,几行代码就能把去水印能力集成到你的程序里。图片处理接口直接返回二进制流,检测与识别返回 JSON,下方附 cURL / Python / JavaScript 调用示例。

端点索引 / ENDPOINTS
GET/health健康检查 · 免费
POST/visible可见水印移除 · 1 点
POST/erase区域擦除 · cv2 1 点 / migan 2 点
POST/metadata/check元数据检测 · 免费
POST/metadata/remove元数据清除 · 1 点
POST/identify来源识别 · 免费
POST/auth/device-login设备登录 · 发放 token
GET/me用户信息与额度快照
POST/quota/redeem兑换码充值
示例 · POST /erase最常用
参数类型说明
fileFile · 必填待处理图片,multipart 字段,单文件 ≤ 20MB
regionsstring · 必填擦除区域 x,y,w,h,多个区域用分号分隔,如 100,200,300,50;500,100,200,80
backendstring · 可选cv2(快速,默认,1 点)或 migan(高质量,2 点)
curl -F 'file=@image.png' \
  -F 'regions=100,200,300,50;500,100,200,80' \
  -F 'backend=migan' \
  https://watermark.yinhangbang.com/erase -o erased.png

200 返回 PNG 二进制;响应头 X-Free-Remaining / X-Paid-Balance 回传最新额度。

错误码 / ERRORS
HTTPcode处理建议
400BAD_REQUEST参数缺失或 regions 格式错误,检查请求体
401UNAUTHORIZEDtoken 缺失或过期,重新 device-login 后重试
402QUOTA_EXCEEDED额度不足,引导兑换或等待次日免费额度
413FILE_TOO_LARGE文件超过 20MB,上传前压缩或降低分辨率
422UNSUPPORTED_FORMAT格式不支持或未检测到可处理目标,参考支持格式列表
429RATE_LIMITED请求过于频繁,退避后重试