Injecting a Watermark into a Document

Function

This API is used to inject a watermark into a document.

URI

POST /v1/{project_id}/sdg/doc/watermark/embed

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header 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).

**Table 3** FormData parameters
Parameter	Mandatory	Type	Description
doc_type	Yes	String	Type of the document into which a watermark is injected. Enumeration values: WORD EXCEL PDF PPT
file_password	No	String	Password for opening a file, which can contain a maximum of 256 characters. Opening a watermarked file does not require a password. 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	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	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. If this field is set to IMAGE: 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, the fields visible_watermark, font_size, rotation, and opacity will not take effect. The text watermark will be overspread over the whole page while the image watermark will be displayed in the middle of the page. Enumeration values: TEXT IMAGE

Response Parameters

Status code: 400

**Table 4** Response body parameters
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"
}

Status Codes

Status Code	Description
200	Request successful.
400	Invalid request.

Error Codes

See Error Codes.

Parent topic: Document Watermarking

Last Article：Document Watermarking

Next Article：Extracting a Document Watermark

Did you find this page helpful?

Failed to submit the feedback. Please try again later.