Injecting Watermarks into Documents (Document Addresses)
Function
This API is used to inject visible text watermarks, invisible text watermarks, or visible image watermarks into Word (.docx), PPT (.pptx), Excel (.xlsx), and PDF (.pdf)* documents. You need to pass a document address (currently, only OBS is supported) and watermark information to this API. DSC returns the storage address of the watermarked document.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/doc-address/watermark/embed
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
region_id |
Yes |
String |
ID of the region where the project is located, for example, xx-xx-1. |
src_file |
Yes |
String |
Address of the document to which the watermark is to be added. Currently, only OBS objects are supported. The format is obs://bucket/object, where bucket indicates the name of the OBS bucket in the same region as the current project, and object indicates the full path name of the object. For example, obs://hwbucket/hwinfo/hw.png. |
doc_type |
Yes |
String |
Type of the document to be watermarked Enumeration values:
|
dst_file |
No |
String |
Storage address of the watermarked document. The format and requirements are the same as those of the src_file field. If this field is not set, the value of src_file is used by default. In this case, the original file is overwritten after the watermark is added. |
blind_watermark |
No |
String |
Content of the invisible text watermark. Either blind_watermark or visible_watermark must be set. |
visible_watermark |
No |
String |
Content of the visible text watermark. Either blind_watermark or visible_watermark must be set. |
image_mark |
No |
String |
Address of document to be injected with a visible image watermark. The field format must be the same as that of src_file. The image file must be in PNG or JPG format. Otherwise, an error is returned. The image file size cannot exceed 1 MB. |
visible_type |
No |
String |
Whether the visible watermark is of the text or image type. If the default value TEXT is used, you need to set visible_watermark to specify a visible text watermark. If this parameter is set to IMAGE, you need to set image_watermark to specify the address of an image watermark. In this case, the visible_watermark, font_size, rotation, and opacity fields will not take effect. Enumeration values:
|
file_password |
No |
String |
Password for reading the file to be watermarked, which can contain a maximum of 256 characters. If an Office Word document requires a password for read or domain control, you need to enter the password to open the file. |
marked_file_password |
No |
String |
Password for a watermarked document, which can contain a maximum of 256 characters. By default, the document does not have a password. |
readonly_password |
No |
String |
Read-only password for a watermarked document, which can contain a maximum of 256 characters. By default, the document does not have a read-only password. |
front |
No |
Integer |
Font size of a visible watermark. The value range is [1, 100], and the default value is 50. |
rotation |
No |
Integer |
Font angle of a visible watermark, in anticlockwise direction. The value range is [0, 90], and the default value is 45. |
opacity |
No |
Float |
Transparency of a visible watermark. The value range is [0, 1], and the default value is 0.3. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
region_id |
String |
ID of the region where the current project is located, for example, xx-xx-1. |
watermarked_file |
String |
Address of the document to which the watermark is to be added. Currently, only OBS objects are supported. The format is obs://bucket/object, where bucket indicates the name of the OBS bucket in the same region as the current project, and object indicates the full path name of the object. For example, obs://hwbucket/hwinfo/hw.doc. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Embed the invisible watermark "blind_watermark" and visible watermark "visible_watermark" to the Word document at obs://hwbucket/hwinfo/hw.doc.
POST /v1/{project_id}/doc-address/watermark/embed { "region_id" : "xx-xx-1", "src_file" : "obs://hwbucket/hwinfo/hw.doc", "doc_type" : "WORD", "blind_watermark" : "blind_watermark", "visible_watermark" : "visible_watermark" }
Example Responses
Status code: 200
Request succeeded.
{ "region_id" : "xx-xx-1", "watermarked_file" : "obs://hwbucket/hwinfo/hw.docx" }
Status code: 400
Invalid request.
{ "error_code" : "DSC.00000007 ", "error_msg" : "File format error" }
SDK Sample Code
The SDK sample code is as follows.
Embed the invisible watermark "blind_watermark" and visible watermark "visible_watermark" to the Word document at obs://hwbucket/hwinfo/hw.doc.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; public class CreateDocWatermarkByAddressSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); CreateDocWatermarkByAddressRequest request = new CreateDocWatermarkByAddressRequest(); CreateDocWatermarkByAddressRequestBody body = new CreateDocWatermarkByAddressRequestBody(); body.withVisibleWatermark("visible_watermark"); body.withBlindWatermark("blind_watermark"); body.withDocType(CreateDocWatermarkByAddressRequestBody.DocTypeEnum.fromValue("WORD")); body.withSrcFile("obs://hwbucket/hwinfo/hw.doc"); body.withRegionId("xx-xx-1"); request.withBody(body); try { CreateDocWatermarkByAddressResponse response = client.createDocWatermarkByAddress(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Embed the invisible watermark "blind_watermark" and visible watermark "visible_watermark" to the Word document at obs://hwbucket/hwinfo/hw.doc.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateDocWatermarkByAddressRequest() request.body = CreateDocWatermarkByAddressRequestBody( visible_watermark="visible_watermark", blind_watermark="blind_watermark", doc_type="WORD", src_file="obs://hwbucket/hwinfo/hw.doc", region_id="xx-xx-1" ) response = client.create_doc_watermark_by_address(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Embed the invisible watermark "blind_watermark" and visible watermark "visible_watermark" to the Word document at obs://hwbucket/hwinfo/hw.doc.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateDocWatermarkByAddressRequest{} visibleWatermarkCreateDocWatermarkByAddressRequestBody:= "visible_watermark" blindWatermarkCreateDocWatermarkByAddressRequestBody:= "blind_watermark" request.Body = &model.CreateDocWatermarkByAddressRequestBody{ VisibleWatermark: &visibleWatermarkCreateDocWatermarkByAddressRequestBody, BlindWatermark: &blindWatermarkCreateDocWatermarkByAddressRequestBody, DocType: model.GetCreateDocWatermarkByAddressRequestBodyDocTypeEnum().WORD, SrcFile: "obs://hwbucket/hwinfo/hw.doc", RegionId: "xx-xx-1", } response, err := client.CreateDocWatermarkByAddress(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Invalid request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot