Add Watermark to Excel Files – Aspose.Cells Cloud Documentation
This REST API adds a watermark to Excel files.
REST API
POST https://api.aspose.cloud/v3.0/cells/watermark
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
Request Parameters
| Parameter Name | Type | Location | Description |
|---|---|---|---|
file |
file | formData (multipart body) | The Excel file to which the watermark will be applied. |
text |
string | query | The watermark text to display. |
color |
string | query | The watermark colour in ARGB hex format (e.g., 004433ff). |
Response
The JSON response contains a Files array. For each file object:
- Filename – name of the processed workbook.
- FileSize – size of the file in bytes.
- FileContent – Base64‑encoded content of the watermarked Excel file; decode it to obtain the actual file.
{
"Status" : "OK",
"Code" : 200,
"Files": [
{
"Filename" : "[file1 name]",
"Filesize" : [file size],
"FileContent" : "[Base64String]"
}, {
"Filename" : "[file2 name]",
"Filesize" : [file size],
"FileContent" : "[Base64String]"
}, {
"Filename" : "[file3 name]",
"Filesize" : [file size],
"FileContent" : "[Base64String]"
}
]
}
Response Status Codes
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Compression succeeded; response contains compressed file details. |
| 400 | Bad Request | Missing or invalid parameters (e.g., unsupported file type). |
| 401 | Unauthorized | Invalid or missing JWT token. |
| 413 | Payload Too Large | Uploaded file exceeds size limit. |
| 500 | Internal Server Error | Unexpected server error. |
How to Use the PostWatermark API with SDKs
PostWatermark API Specification
The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.
You can use the cURL command‑line tool to call Aspose.Cells web services. The example below shows a complete request, including the required authentication header. Replace <your‑jwt‑token> with a valid JWT access token obtained from the Aspose authentication endpoint.
Use Aspose.Cells Cloud SDKs
Using an SDK is the fastest way to develop. An SDK abstracts low‑level details, allowing you to focus on your business logic. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.
The following code examples demonstrate how to call Aspose.Cells web services using various SDKs: