You need to enable JavaScript to run this app.
导航
创建盲水印前背景图层
最近更新时间:2024.06.03 17:41:21首次发布时间:2023.12.15 19:59:57

本接口支持生成含有盲水印的 png 格式透明图,适用于纯色背景网页被截图外发后进行截图者身份溯源场景。

注意事项

  • 计费说明:盲水印功能属于附加组件下智能处理模块,属于后付费计费,使用后会产生附加组件智能处理费用
  • 前提条件:请确保已开通智能处理计费配置
  • 使用限制:提取水印前,请先确认盲水印使用限制
  • 请求频率:单用户请求频率限制为 5 次/秒
  • 超时时间:超时时间约为 30 秒
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:POST
  • 请求地址:https://imagex.volcengineapi.com/?Action=CreateHiddenWatermarkImage&Version=2023-05-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringCreateHiddenWatermarkImage接口名称。当前 API 的名称为 CreateHiddenWatermarkImage
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

ServiceId

String

h1**0k

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面,在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID,具体请参考获取所有服务信息

Body

参数类型是否必选示例值描述
AlgorithmStringtracev1获取盲水印图的算法模型,仅支持取值 tracev1。该模型可以生成带有水印的透明图像,但仅适用于纯色网页泄露溯源场景。该模型可有效抵抗常见的社交软件传播。然而,该算法对页面背景色的影响相对较大,因此不适合用于保护多彩页面或图片,例如商品页面。

Strength

String

medium

盲水印强度,取值如下所示:

  • low:低强度,适用于对图像质量要求高。
  • medium:中强度
  • strong:高强度,适合图像纹理丰富时使用。
InfoString你好自定义盲水印文本信息,最大支持 128 个字符。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
StoreUriStringtos-cn-i-h1**0k-example.png盲水印图片 Uri,当前仅支持输出 png 格式。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateHiddenWatermarkImage&Version=2023-05-01&ServiceId=h1**0k

{
    "Algorithm": "tracev1",
    "Strength": "low",
    "Info": "你好"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreateHiddenWatermarkImage",
        "Version": "2023-05-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "StoreUri": "tos-cn-i-h1**0k-example.png"
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。

服务端 SDK

为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: