本接口支持指定服务以及原图后,将自定义的文字盲水印等信息嵌入原图并获取结果图 URI。
注意
请在原图完成全部图片处理操作(如裁剪、缩放、画质增强等)之后再添加盲水印,以免影响水印的稳定性导致无法正常提取水印。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateImageHmEmbed | 接口名称。当前 API 的名称为 CreateImageHmEmbed 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ServiceId | String | 是 |
| 待添加盲水印图片对应的服务 ID。 |
StoreUri | String | 否 | tos-boe-i-oz***y2/cf***9d.jpg | 待添加盲水印的原图 URI,您可在控制台资源管理获取图片的存储 URI。当 StoreUri 和 ImageUrl 均不为空,以 StoreUri 取值为准。 |
ImageUrl | String | 否 | https://test.com/tos-boe-i-oz***y2/example.png | 待添加盲水印的可公网访问原图 Url,您可在控制台资源管理获取图片访问 URL。当 StoreUri 和 ImageUrl 均不为空,以 StoreUri 取值为准。 |
Algorithm | String | 是 |
| 算法模型,取值如下所示:
|
Info | String | 是 | 你好 abc123%^$% | 自定义盲水印文本内容,最大支持 128 个字符。 |
OutFormat | String | 否 |
| 输出图片格式,默认 png,支持图片格式有:
|
OutQuality | Integer | 否 |
| 输出图片质量参数。取值范围为 [1,100],默认为 75。
|
StrengthLevel | String | 否 |
| 算法强度,强度越高,图像抵抗攻击性能越强。取值如下所示:
|
Strength | Integer | 否 |
| 仅当
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
StoreUri | String | tos-boe-i-oz***y2/9b***76 | 添加盲水印后的结果图 Uri。您可使用结果图 URI 拼接完整访问 URL 后,在浏览器查看盲水印效果。 |
POST https://imagex.volcengineapi.com/?Action=CreateImageHmEmbed&Version=2023-05-01 { "ServiceId": "oz***y2", "StoreUri": "tos-boe-i-oz***y2/cf***9d.jpg", "Info": "你好 abc123%^$%", "OutFormat": "png", "StrengthLevel": "strong", "Algorithm": "default" }
{ "ResponseMetadata": { "RequestId": "2022082316404301017425518104A49986", "Action": "CreateImageHmEmbed", "Version": "2023-05-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "StoreUri": "tos-boe-i-oz***y2/9b***76" } }
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。
为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示:
2018-08-01 版本 CreateImageHmEmbed 接口文档现已停止维护,建议您参考本文档使用最新版本。