添加图片页眉页脚 - Excel API
PDF4me 添加图片页眉页脚 允许您添加可自定义的图像页眉和页脚 Excel 具有全面定位和格式控制功能的文档。 API 服务流程 Excel 文件并添加图像页眉或页脚,可控制位置(页眉/页脚)、水平对齐方式(左对齐、居中、右对齐)、工作表目标(特定工作表或所有工作表)以及以厘米为单位的页面边距。 API 接收 Excel 通过文档内容和图像数据 REST API 利用电话 Base64 用于安全传输的编码。支持 PNG, JPG, JPEG该解决方案支持 JPEG 和 GIF 图像格式,是企业品牌推广、专业报告和文档自动化工作流程的理想选择。
验证您的身份 API 要求
请包含您的 API 请求中用于身份验证的密钥 PDF4me REST API。
主要特点
- 页眉或页脚位置选择将图像放置在文档页眉还是页脚部分。
- 位置控制在页眉/页脚区域内,将图像左对齐、居中对齐或右对齐。
- 工作表目标:按名称或索引将图像应用于特定工作表,或应用于所有工作表
- 利润率定制:以厘米为单位配置页面上、下、左、右边距
- 图像格式支持: PNG, JPG, JPEG以及 GIF 格式
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有图像头部/尾部操作 Excel 通过单个端点执行:
- 方法: POST
- 终点:
office/ApiV2Excel/ExcelAddImageHeaderFooter
REST API 参数
重要的: 标有星号 (*) 的参数为必填项。所有请求均使用 文档, 文档内容, 图片内容 (根级别),以及 addImageHeaderFooterToExcelAction其他选项是操作对象的属性。
必需参数(根级别)
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 文档* | Object | 文件参考。必须包含 姓名 (细绳): Excel 文件名带有 .xlsx 或 .xls 扩展名。 | { "Name": "data.xlsx" } |
| 文档内容* | String (Base64) | Excel 文档内容编码 Base64 | UEsDBBQABgAIAAAA... |
| 图片内容* | String (Base64) | 图像文件内容编码为 Base64支持 PNG, JPG, JPEGGIF格式 | iVBORw0KGgoAAAANS... |
| addImageHeaderFooterToExcelAction* | Object | 操作配置(位置、工作表目标、边距等) | 请参见下方的有效载荷示例。 |
可选参数(位于 addImageHeaderFooterToExcelAction 函数内部)
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| isHeader | Boolean | 岗位选择。 true = 将图像添加到文档头部(默认), false = 在文档页脚添加图片 | true |
| 位置 | String | 页眉/页脚内的水平对齐方式。 左边, 中心, 或者 正确的默认值:“居中”。不区分大小写。 | Center |
| 工作表名称 | Array (细绳[]) | 要应用图像的工作表名称数组。如果 worksheetNames 和 worksheetIndexes 都为空,则图像应用于所有工作表。 | ["Sheet1", "Report"] |
| 工作表索引 | Array (int[]) | 工作表索引数组(从 1 开始)。如果 worksheetNames 和 worksheetIndexes 都为空,则应用于所有工作表。 | [1, 2] |
| 上边距 | 数字(双精度浮点数) | 页面顶部边距(厘米)。默认值:1.9 | 1.9 |
| 底部边距 | 数字(双精度浮点数) | 页面底部边距(厘米)。默认值:1.9 | 1.9 |
| 左边距 | 数字(双精度浮点数) | 页面左边距,单位为厘米。默认值:1.9 | 1.9 |
| 右边距 | 数字(双精度浮点数) | 页面右边距,单位为厘米。默认值:1.9 | 1.9 |
| 文化名称 | String | 文档处理的区域性代码(例如“en-US”、“de-DE”、“fr-FR”) | en-US |
笔记: 如果两者 工作表名称 和 工作表索引 如果为空或为null,则图像将应用于所有工作表。 Excel 文件。
输出
这 PDF4me 添加图片页眉页脚 REST API 返回 Excel 以文件形式 Base64-编码字符串 JSON 格式不是二进制数据。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同步处理(默认)
这 API 处理请求并返回:
状态码: 200 OK
Content-Type: application/json
回复正文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
回复字段:
- 文档 (字符串): Excel 应用了图像页眉/页脚的文档,编码为 Base64 细绳
- 文件名 (字符串):输出 Excel 文件名
- 成功 (布尔值):指示请求是否成功
- 错误信息 (字符串或 null):成功失败时的错误详情
使用方法:
- 提取
document来自该领域的 JSON 回复 (Base64) - 解码 Base64 获取二进制文件的字符串 Excel 文档数据
- 保存或处理 Excel 根据需要归档
例子 (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const excelBytes = atob(data.document); // Decode Base64
// Save or process excelBytes
异步处理
异步行为(202) Accepted 轮询机制由服务器配置控制,而不是由请求体参数控制。启用后, API 可能会返回 202 状态码,并进行轮询 URL 在 Location 标题。轮询 URL 和 GET 直到收到 200 个请求为止 OK 响应格式相同(文档、文件名、成功、错误消息)。
错误响应
这 API 退货标准 HTTP 错误代码及错误详情:
- 无效的请求参数
- 缺少必填字段
文档和姓名,文档内容,图片内容,addImageHeaderFooterToExcelAction) - 无效的 Base64 编码
文档内容或者图片内容 - 无效或已损坏 Excel 文档
- 无效或损坏的图像文件
- 工作表选择无效(名称或索引不存在或超出范围)
- 无效或缺失 API 钥匙
- API 钥匙未正确 Base64 编码 Authorization 标题
- 丢失的
授权方式:基本标题
- 服务器端处理错误
- Excel 文档处理失败
- 图片页眉/页脚添加失败
错误响应格式:
{
"error": "Error message describing what went wrong"
}
回复格式详情
重要的: 这 API 总是返回 JSON绝非二元 Excel 直接传输数据。
响应结构:
{
"document": "string", // Base64-encoded Excel document content
"fileName": "string", // Output Excel filename
"success": true,
"errorMessage": "string or null"
}
解码 Base64 到 Excel 文档:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
excel_bytes = base64.b64decode(response['document'])
with open('output.xlsx', 'wb') as f:
f.write(excel_bytes)
C#:
byte[] excelBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.xlsx", excelBytes);
请求示例
标题
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": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {}
}
高级示例(包含所有可选字段):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {
"isHeader": true,
"position": "Center",
"worksheetNames": ["Sheet1", "Report"],
"worksheetIndexes": [1, 2],
"topMargin": 1.9,
"bottomMargin": 1.9,
"leftMargin": 1.9,
"rightMargin": 1.9,
"cultureName": "en-US"
}
}
代码示例
这 PDF4me 添加图像页眉页脚 Excel REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言:
- C#
- Java
- JavaScript
- Python
行业应用案例及应用
- Finance & Accounting
- Sales & Marketing
- Human Resources
- Operations & Manufacturing
- Healthcare & Medical
- Legal & Professional Services
财务与会计应用案例
- 财务报表在季度报告中添加公司徽标标题
- 预算报告在预算工作表上插入部门徽标
- 审计文件在页脚添加审计公司标志水印
- 费用报告:在费用报销单上添加公司标志页眉
销售与市场营销用例
- 销售报告在每周销售报告中插入公司品牌标识
- 价格表在客户定价文档中添加徽标标题
- 市场营销报告将活动徽标应用于分析报告
- 客户演示在交付成果中添加客户联合品牌标识
人力资源应用案例
- 工资报表在工资单上插入公司徽标页眉
- 员工记录在人事模板中添加人力资源部门徽标
- 福利登记在登记表上贴上福利提供商的标志。
- 绩效考核在评论模板中添加企业品牌标识
运营与制造应用案例
- 库存报告在库存清单上插入仓库位置标识
- 生产报告在制造报告中添加生产设施徽标
- 质量报告在页眉中应用质量认证标志
- 供应链报告在采购文件中添加供应商徽标
医疗保健应用案例
- 患者报告在患者数据中添加医院或诊所徽标标题
- 实验室结果在检测结果单上插入实验室标志标识
- 保险索赔在理赔文件上添加保险公司标识
- 医疗记录在健康信息表上添加机构品牌标识
法律及专业服务用例
- 客户报告在客户交付物上插入律师事务所标志标题
- 案件文件在法律案件文件中添加业务领域徽标
- 合同模板在合同工作表中应用公司品牌标识
- 账单在法律账单报告上插入公司徽标