Injecting Watermarks into Documents
Function
This API is used to inject invisible text watermarks, visible text watermarks, or visible image watermarks into Word (.docx), PPT (.pptx), Excel (.xlsx), and PDF (.pdf) files. You need to pass file and watermark information in formData format to this API, DSC returns the binary stream of the watermarked file.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/sdg/doc/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, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
doc_type |
Yes |
String |
Type of the document into which a watermark is injected. Enumeration values:
|
file_password |
No |
String |
This API is used to read file passwords, 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 |
This API is used to set a password for the file after the watermark is added. The maximum length is 256 characters. The file is not encrypted by default and does not require a password. |
readonly_password |
No |
String |
This API is used to set a password for reading the file after the watermark is added. The maximum length is 256 characters. By default, the file is not encrypted for reading and does not require a password. |
visible_watermark |
No |
String |
Visible watermark content. |
font_size |
No |
String |
Font size of a visible watermark. The value ranges from 1 to 100, and the default value is 50. |
rotation |
No |
String |
Font angle of a visible watermark, in anticlockwise direction. The value range is [0, 90], and the default value is 45. |
opacity |
No |
String |
Transparency of a visible watermark. The value range is [0, 1], and the default value is 0.3. |
blind_watermark |
No |
String |
Invisible watermark content. |
file |
Yes |
File |
Document into which a watermark is injected. |
image_mark |
No |
File |
Image added in the document as the watermark. The image must be in the PNG or JPG format and cannot exceed 1 MB. The value of name in Content-Disposition in the API request must be set to image_mark. |
visible_type |
No |
String |
Type of visible watermark. The default value of this field is TEXT. When this field is set to IMAGE:
Enumeration values:
|
Response Parameters
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Submit the request using the form. The "file" indicates a specified document.
POST /v1/{project_id}/sdg/doc/watermark/embed { "file" : "test.doc", "doc_type" : "WORD", "opacity" : "0.1", "font_size" : "30", "rotation" : "45", "blind_watermark" : "blind_watermark", "visible_watermark" : "visible_watermark" }
Example Responses
Status code: 200
Request successful.
"{\"Watermarked document\"}"
Status code: 400
Invalid request.
{ "error_code" : "DSC.00000007 ", "error_msg" : "File format error" }
SDK Sample Code
The SDK sample code is as follows.
Submit the request using the form. The "file" indicates a specified document.
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 53 54 55 |
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 CreateDocWatermarkSolution { 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(); CreateDocWatermarkRequest request = new CreateDocWatermarkRequest(); CreateDocWatermarkRequestBody bodybody = new CreateDocWatermarkRequestBody(); bodybody.withDocType(CreateDocWatermarkRequestBody.DocTypeEnum.fromValue("WORD")) .withVisibleWatermark("visible_watermark") .withFontSize("30") .withRotation("45") .withOpacity("0.1") .withBlindWatermark("blind_watermark") .withFile("test.doc"); body.withBody(bodybody); request.withBody(listbodyBody); try { CreateDocWatermarkResponse response = client.createDocWatermark(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()); } } } |
Submit the request using the form. The "file" indicates a specified document.
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 |
# 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 = CreateDocWatermarkRequest() bodybody = CreateDocWatermarkRequestBody( doc_type="WORD", visible_watermark="visible_watermark", font_size="30", rotation="45", opacity="0.1", blind_watermark="blind_watermark", file="test.doc" ) request.body = listBodybody response = client.create_doc_watermark(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Submit the request using the form. The "file" indicates a specified document.
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 |
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.CreateDocWatermarkRequest{} visibleWatermarkBody:= "visible_watermark" fontSizeBody:= "30" rotationBody:= "45" opacityBody:= "0.1" blindWatermarkBody:= "blind_watermark" bodybody := &model.CreateDocWatermarkRequestBody{ DocType: model.GetCreateDocWatermarkRequestBodyDocTypeEnum().WORD, VisibleWatermark: &visibleWatermarkBody, FontSize: &fontSizeBody, Rotation: &rotationBody, Opacity: &opacityBody, BlindWatermark: &blindWatermarkBody, File: "test.doc", } request.Body = listBodybody response, err := client.CreateDocWatermark(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 successful. |
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