• 点击切换深浅主题
    • 一、开始接入
    • 二、请求参数
    • 三、响应码列表
    • 四、响应数据列表
      • 五、响应数据示例
      • 六、SDK && DEMO

          • 点击切换深浅主题

           

          一、开始接入

          ① 接入地址

          ② 请求方式

          ③ 接入事项

          二、请求参数

          ① 签名信息

          ② 请求参数

          字段名称类型是否必填默认备注
          imageFileFile否，image_file / image_url / image_base64 必须提供一个无图片文件，仅支持格式为 image/png image/bmp image/jpeg 的图片，且大小不超过 4MB
          imageUrlString否，image_file / image_url / image_base64 必须提供一个无图片链接，仅支持格式为 image/png image/bmp image/jpeg 的图片，且大小不超过 4MB
          imageBase64String否，image_file / image_url / image_base64 必须提供一个无图片通过 base64 的方式进行编码后得到的字符串，仅支持格式为 image/png image/bmp image/jpeg 的图片，且大小不超过 4MB，不建议采用 Base64 编码
          rectanglesJson否无矩形坐标，为空默认将识别到图中的文字水印信息作为矩形坐标，如提供该参数，请正确填写，如提供有误则请求不成功，明确指定该参数后 watermarkNames / excludeKeywords / offset 将无效且服务器不会识别出图片中的文字矩形区域，可提供多个矩形坐标，例如：
          [
                {
                  "x": 120,
                  "y": 76,
                  "w": 100,
                  "h": 173
                },
                {
                  "x": 114,
                  "y": 80,
                  "w": 132,
                  "h": 206
                }
          ]
          watermarkNamesJson否无根据给定的水印名称去除识别到的图中的文字水印名称，该参数仅在不明确指定矩形坐标参数时生效，且该参数和 excludeKeywords 只能指定其中一个生效，参数可提供多个


          以下为一个完整的例子，其中包含的 value 属性为你需要排除的水印文字，rule 属性为排除规则，可选的值有 similar、absolute、default

          similar 表示根据距离编辑算法决定是否去除或排除文字水印，确认值为 75%
          absolute 表示将绝对根据给定的文字水印，输入需要完全一致才能进行去除或排除，确认值为 100%
          default 表示默认使用 similar 进行操作，如 rule 的值有误或留空默认也使用 default 属性
          {
            "items": [
              {
                "value": "去除水印名称1",
                "rule": "similar"
              },
              {
                "value": "去除水印名称2",
                "rule": "absolute"
              },
              {
                "value": "去除水印名称3",
                "rule": "default"
              }
            ]
          }
          excludeKeywordsJson否无排除图片中的水印文字，该功能仅在不明确指定矩形坐标参数时生效，且该参数和 markNames 只能指定其中一个

          以下为一个完整的例子，其中包含的 value 属性为你需要排除的水印文字，rule 属性为排除规则，可选的值有 similar、absolute、default

          similar 表示将根据距离编辑算法决定是否去除文字水印，确认值为 75%
          absolute 表示将绝对根据给定的文字水印，输入需要完全一致才能进行去除，确认值为 100%
          default 表示默认使用 similar 进行操作，如 rule 的值有误或留空默认也使用 default 属性

          {
            "items": [
              {
                "value": "排除水印名称1",
                "rule": "similar"
              },
              {
                "value": "排除水印名称2",
                "rule": "absolute"
              },
              {
                "value": "排除水印名称3",
                "rule": "default"
              }
            ]
          }
          offsetJson否无矩形偏移量，在识别到的文本矩形框额外缩小或放大矩形大小，仅能使用 +x + y +w +h -x -y -w -h 指定缩小还是放大偏移量，如识别出的文字矩形区域额外添加偏移量后造成矩形超出图像框架范围，则忽略 offset 参数重试并响应。以下为一个简单的例子：
          {
            "+x": 5,
            "-y": 8,
            "-w": 3,
            "+h": 4
          }
          syncBoolean否false是否异步处理，如设定为 true 则表示启用，请先设置好 callback 回掉接口
          callbackStringsync 参数为 true 时必须无如 sync 显示的设定为了 true，将立即响应状态信息，处理包含数据的结果将发送给指定的 callback 回掉接口，如首次请求 callback 失败，服务器会重新尝试响应 1 次，请注意，即使没有成功发送消息至 callback 指定的服务器，也依然会扣除使用次数，处理失败情况除外，服务器校验响应是否成功取决于目标回掉接口是否返回 HTTP 状态码 200，所以在提交大量异步请求前，请先确认 callback 接口是否能正常接收响应
          ocrOnlyBoolean否false是否仅识别图片中的文字水印矩形坐标等信息，默认为 false ，详情参考响应数据例子
          showBoolean否false是否标识出处理的矩形区域，默认为 false

          三、响应码列表

          ① HTTP 响应码列表

          响应码含义备注
          200请求成功，但处理不一定成功，具体看 data 对象中的 processStatus处理成功
          304自上次的请求以来本次响应未做任何修改自上一次请求后，响应处于缓存期中，本次响应为缓存数据，在缓存期间不扣除使用次数
          400请求参数错误检查是否少传了必要参数，或指定了错误的参数
          401认证失败检查提供的签名参数，以及生成 sign 的方法
          403拒绝请求服务器拒绝请求，可能是账户可使用次数不足
          405请求方法不被允许检查请求方法
          413上传文件大小超出限制请检查文件大小，最大 4 MB
          429请求频率超出 QPS 限制（默认 QPS 为 2）请放缓请求速率
          500服务端系统出错重试或联系管理员

          ② 处理响应码列表

          响应码含义备注
          0处理成功-
          52000异步调用返回状态码异步调用的请求将立即响应状态信息，处理包含数据的结果将发送给指定的 callback 回掉接口
          52001未处理没有进行图片处理，原因可能是没有通过校验，例如上传的文件超出大小限制、非法请求、提供的参数有误等等，该响应码不会扣除账户使用次数
          52002未处理由于没有明确或正确指定水印矩形坐标，且服务器无法识别到图片中有任何的文字水印矩形坐标将返回该状态码，不消耗使用次数
          52003请求超时重试或联系管理员，不消耗使用次数
          52004服务端系统出错重试或联系管理员，不消耗使用次数
          52005提供的偏移量参数不正确出现该状态码表示服务器依然完成了对图片的去水印操作，但提供的偏移量参数未能生效，原因是对原始图片的坐标轴信息进行坐标偏移操作后，超出了原始图片的边框限制。消耗使用次数
          52006未进行水印去除操作由于指定了参数 ocrOnly 为 true，所以服务器仅识别图片中的文字水印矩形坐标等信息，不对识别到的区域进行水印去除操作，仍扣除使用次数

          四、响应数据列表

          字段含义
          httpCode本次请求状态，具体参照响应码列表
          httpMsg本次请求状态信息
          returnType本次响应返回的数据类型
          remainingUsage当前用户剩余可使用次数
          allUsedCount账户总调用次数
          longTermUsageCount账户长期可调用次数
          limitedTermUsageCount账户限期可调用次数
          limitedTermExpireTimes账户限期次数到期时间
          location客户端请求发起 IP 地址
          msgInnerReferer内部消息来源，成功时为空，失败时可根据该信息进行定位
          data为一个对象，封装了本次请求的具体响应数据，包括去水印后的数据。在处理异步请求时返回的 data 对象不包含处理数据
          processStatus本次处理状态码，具体参照响应码列表
          processMsg本次处理状态信息
          processLocation本次处理的矩形坐标，为一个 json list，list 中的每一项依次代表着 left、top、width、height，lineCount 为自动合并了多少行，watermark 为四个坐标轴框选的文字
          processCount对本次请求上传图片的处理次数
          url本次去水印后图片的 URL 地址，注意：响应的数据在服务器端仅保留 5 小时，平滑期为 5 分钟，超时自动销毁，在缓存期间内重复调用不扣除账户使用次数

           

          五、响应数据示例

          ① 同步调用成功

          ② 异步调用成功

          ③ 仅识别文字水印矩形（不处理水印）

          ④ 缓存

          ⑤ 失败

          六、SDK && DEMO