在 Word 文档中添加文本水印 - 文本水印 API
PDF4me 在 Word 中添加文本水印 此功能允许您向 Word 文档添加可自定义的文本水印,并提供全面的样式和定位控制。 API 该服务可处理 Word 文件并添加文本水印,并可完全控制文本内容、字体、字号、颜色、旋转角度、方向预设和透明度级别。 API 通过以下方式接收 Word 文档内容 REST API 利用电话 Base64 用于安全传输的编码。该解决方案支持安全标签、品牌元素、保密声明和状态标记,是文档安全、品牌保护和状态指示工作流程的理想之选。
验证您的身份 API 要求
要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份。 REST API。
主要特点
- 支持文本水印:可自定义任何文本内容的专业文字水印
- 字体自定义完全控制字体系列、字体名称和字体大小
- 颜色选项支持颜色名称、十六进制代码、RGB 值和 3 位十六进制数。
- 旋转控制自定义旋转角度(0-360°)或预定义方向预设
- 透明度选项半透明或完全不透明的水印效果
- 自动尺寸调整:根据文本长度和字体大小进行智能调整
- 文档范围应用所有章节和标题均已添加水印
- 文本放置背后的原因水印位于文档内容的后面
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有文本水印添加操作均通过单个端点执行:
- 方法: POST
- 终点:
office/ApiV2Word/AddTextWatermark
REST API 参数
“在 Word 中添加文本水印”功能的完整参数列表 REST API参数按类别组织,以便更好地理解和实施。
重要的: 标有星号 (*) 的参数为必填项,必须提供。 API 正常运作。
必需参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 文档* | Object | 文档描述符。必须包含 姓名 (字符串):输出带有 .docx 扩展名的 Word 文件名 | { "Name": "document.docx" } |
| 文档内容* | Base64 | Word文档内容编码 Base64 | UEsDBBQABgAIAAAA... |
| 水印文字* | String | 用于显示水印的文本。必填 - 不能为空、空白或仅包含空格。示例:“机密”、“草稿”、“已批准” | CONFIDENTIAL |
可选参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 字体系列 | String | 水印文本字体系列。常用字体:Arial、Calibri、Times New Roman、Helvetica。默认字体:Arial。 | Arial |
| 字体大小 | Number (双倍的) | 字体大小,单位为磅(1 至 1000)。默认值:72 | 72 |
| 字体颜色 | String | 文本颜色。名称:“红色”、“蓝色”、“灰色”。十六进制:“#FF0000”、“FF0000”。RGB:“RGB(255,0,0)”。默认值:“#808080”。 | #FF0000 |
| 半透明 | Boolean | 透明度。 true = 不透明度 50%, false = 100%(默认值) | true |
| 旋转 | Number (双倍的) | 自定义旋转角度(0-360°)。默认值:0 | 45 |
| 字体名称 | String | 水印文本的字体名称 | Arial |
| 方向 | String | 预设方向: 水平的 (0°), 垂直的 (90°), 对角线 (45°), 倒挂 (180°)。如果提供旋转角度,则覆盖此设置。 | Diagonal |
| 文化名称 | String | 文化代码(例如“en-US”、“de-DE”、“fr-FR”)。默认值:空 | en-US |
文本方向选项
水印文字方向遵循以下参数优先级:
- 方向 - 如果提供,则使用预定义的方位角
- 旋转 - 如果未提供方向,则使用自定义旋转角度
- 默认 - 如果两者都未提供,则使用 0°(水平)
预设方向:
- 水平的:0°(默认值)
- 垂直的:90°
- 对角线45°
- 倒挂180°
输出
这 PDF4me 在 Word 中添加文本水印 REST API 返回一个 JSON 响应(ApiV2WordApiCallRes)。成功后 API 返回 Word 文档。 Base64编码字符串 在 document 字段,而不是二进制数据。
- Success Response
- Error Responses
- Response Format Details
成功响应
状态码: 200 OK
内容类型: application/json
回复正文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
回复字段:
- 文档 (字符串):应用了文本水印的 Word 文档,编码为 Base64
- 文件名 (字符串):输出的 Word 文件名
- 成功 (布尔值):操作是否成功。
- 错误信息 (字符串):如果成功为 false,则显示错误消息;否则为 null。
使用方法:
- 查看
success;如果为真,则提取document来自该领域的 JSON 回复 - 解码 Base64 获取二进制 Word 文档数据的字符串
- 使用以下命令保存或处理 Word 文件
fileName
示例(JavaScript):
const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const wordBytes = atob(data.document);
// Save or process wordBytes
错误响应
这 API 退货标准 HTTP 错误代码及错误详情:
- 无效的请求参数
- 缺少必填字段
文档,文档内容,水印文字) 水印文字不能为空、无意义或仅包含空格。- 无效的 Base64 编码
文档内容 - 无效或损坏的 Word 文档
- 字体大小无效(必须介于 1-1000 之间)
- 无效的旋转角度
- 无效或缺失 API 钥匙
- API 钥匙未正确 Base64 编码 Authorization 标题
- 丢失的
授权方式:基本标题
- 服务器端处理错误
- Word文档处理失败
- 文本水印添加失败
错误响应格式:
{
"error": "Error message describing what went wrong"
}
回复格式详情
重要的: 这 API 总是返回 JSON绝不会直接处理二进制 Word 数据。
响应结构(ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": null
}
内容类型标头:
- 成功:
application/json - Word 文档以嵌入方式呈现。 Base64 字符串内部 JSON 回复
为什么 Base64?
- JSON-二进制数据的安全编码
- 易于传输 HTTP
- 与所有编程语言兼容
- 可以直接嵌入 JSON 不回避问题
解码 Base64 转换为 Word 文档:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, wordBytes);
请求示例
标题
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
笔记:
- 获得你的 API 钥匙 PDF4me 仪表板
- 这 API 关键必须是 Base64 编码后以“Basic”为前缀 Authorization 标题
- 例如:如果你的 API 关键是
abc123将其编码为 Base64 并使用Authorization: Basic YWJjMTIz
有效载荷
基本示例(仅必填字段):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL"
}
高级示例(含可选字段):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL",
"orientation": "Diagonal",
"fontFamily": "Arial",
"fontSize": 72,
"fontColor": "#FF0000",
"semiTransparent": true,
"cultureName": "en-US"
}
自定义旋转示例:
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "DRAFT",
"fontFamily": "Times New Roman",
"fontSize": 48,
"fontColor": "Gray",
"rotation": 45,
"semiTransparent": true
}
代码示例
这 PDF4me 在 Word 中添加文本水印 REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
行业应用案例及应用
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
法律及专业服务用例
- 机密文件在法律文件上添加“机密”水印
- 合同草案将协议草案标记为“草案 - 审核中”状态
- 特权标签应用“律师-客户特权”文字水印
- 状态标记请注明“已批准”或“待审核”状态
商业及企业应用案例
- 价格表在价目表上添加“保密价格”字样水印
- 提案在客户提案上添加“© 2024 [公司名称]”水印
- 内部报告:将内部分析数据标记为“仅供内部使用”
- 草稿材料:请注明“草稿 - 不得分发”状态
教育与研究应用案例
- 患者数据在患者记录中添加“HIPAA 保护”文本水印
- 医疗报告在实验室检测结果上添加“机密医疗”字样的水印
- 研究数据添加“研究数据 - 机密”文字水印
- 保险索赔在保险文件上标注“隐私保护”标签
金融与银行业应用案例
- 财务报表担保在财务报告中添加“机密”字样水印
- 预算草案在预算草案文件上添加“DRAFT”状态水印
- 审计文件在审计交付物上添加“审计副本”文本水印
- 客户报告在面向客户的报告中添加“© 2024 [公司名称]”文本水印