Injecting Watermarks into Documents (Document Addresses)

project_id

Yes

String

Project ID.

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.

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 cloud service 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:

• WORD

• EXCEL

• PDF

• PPT

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:

• TEXT

• IMAGE

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.

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 cloud service 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.

error_code

String

Error Code

error_msg

String

Error Message

200

Request succeeded.

400

Invalid request.