添加文本页眉页脚 - Excel API
PDF4me 添加文本页眉页脚 允许您添加可自定义的文本页眉和页脚 Excel 具有全面格式控制功能的文档。 API 服务流程 Excel 文件,并向页眉或页脚部分添加文本,可设置字体样式(字体系列、大小、颜色)、透明度、旋转角度和方向选项(水平、垂直、对角线、倒置)。 API 接收 Excel 通过文档内容 REST API 利用电话 Base64 采用编码实现安全传输。此方案非常适合文档品牌化、页码、日期标注以及专业演示工作流程。
相关博客文章
目前尚无关于此功能的博客文章——敬请期待。
在此期间,您可以浏览 PDF4me 博客,查看适用于各平台的教程和工作流程。
访问博客 →
验证您的身份 API 要求
请包含您的 API 请求中用于身份验证的密钥 PDF4me REST API。
主要特点
- 自定义文本内容在页眉或页脚中添加任何文本 Excel 文件
- 字体自定义控制字体系列、大小、颜色和特定字体名称
- 透明度控制设置文本半透明(50% 不透明度)或完全不透明(100%)。
- 旋转与方向:应用旋转角度或预设方向(水平、垂直、对角线、倒置)
- 文化支持:指定区域性代码以正确渲染和格式化文本
REST API 端点
- 方法: POST
- 终点:
office/ApiV2Excel/ExcelAddTextHeaderFooter
REST API 参数
重要的: 标有星号 (*) 的参数为必填项。所有请求均使用 文档, 文档内容以及一个操作对象。操作特定的参数是以下对象的属性: addTextHeaderFooterToExcelAction。
必需参数(根级别)
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 文档* | Object | 文件参考。必须包含 姓名 (细绳): Excel 文件名带有 .xlsx 或 .xls 扩展名。 | { "Name": "data.xlsx" } |
| 文档内容* | String (Base64) | Excel 文档内容编码 Base64 | UEsDBBQABgAIAAAA... |
| addTextHeaderFooterToExcelAction* | Object | 操作配置。必须包含至少 水印文字 (字符串):要显示为页眉或页脚的文本 | 请参见下方的有效载荷示例。 |
可选参数(位于 addTextHeaderFooterToExcelAction 内部)
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 字体系列 | String | 字体系列名称(例如,Arial、Times New Roman)。默认值:Arial | Arial |
| 字体大小 | 数字 | 字体大小以磅为单位(8-72)。默认值:72 | 12 |
| 字体颜色 | String | 十六进制颜色代码或颜色名称。默认值:黑色 | #0000FF |
| 半透明 | Boolean | true = 50% 不透明度,false = 100%(默认值) | false |
| 旋转 | 数字 | 旋转角度,单位为度(0-360)。默认值:0 | 45 |
| 字体名称 | String | 指定字体名称(覆盖 fontFamily) | Arial Bold |
| 方向 | String | 水平的, 垂直的, 对角线, 或者 倒挂优先于旋转 | Horizontal |
| 文化名称 | String | 文本渲染区域代码(例如,“en-US”、“de-DE”) | en-US |
输出
这 API 返回 Excel 以文件形式 Base64-编码字符串 JSON 格式。
- Success Response
- Error Responses
状态码: 200 OK
回复正文:
{
"document": "UEsDBBQABgAIAAAA...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
400 Bad Request无效参数、缺少必填字段、无效 Base64 或文件。 401 Unauthorized无效或缺失 API 钥匙。 500 Internal Server Error服务器端处理错误。
请求示例
标题
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
有效载荷(基本)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024"
}
}
有效载荷(可选择格式化)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024",
"fontFamily": "Arial",
"fontSize": 12,
"fontColor": "#0000FF",
"orientation": "Horizontal"
}
}
代码示例
- GitHub