Agregar imagen al encabezado y pie de página - Excel API
PDF4me Agregar imagen al encabezado y pie de página te permite agregar encabezados y pies de página de imágenes personalizables a Excel documentos con control integral de posicionamiento y formato. API procesos de servicio Excel archivos y agrega encabezados o pies de página de imagen con control de ubicación (encabezado/pie de página), alineación horizontal (izquierda, centro, derecha), selección de hoja de cálculo (hojas específicas o todas las hojas) y márgenes de página en centímetros. API recibe Excel contenido del documento y datos de imagen a través de REST API llamadas, utilizando Base64 codificación para transmisión segura. Con soporte para PNG, JPG, JPEGGracias a su compatibilidad con formatos de imagen GIF, esta solución es ideal para la imagen corporativa, los informes profesionales y los flujos de trabajo de automatización de documentos.
Autenticando su API Pedido
Incluye tu API clave en la solicitud para autenticarse con el PDF4me REST API.
Características principales
- Ubicación del encabezado o pie de página: Elija si desea colocar las imágenes en la sección de encabezado o pie de página del documento.
- Control de posiciónAlinee las imágenes a la izquierda, al centro o a la derecha dentro del área del encabezado/pie de página.
- Hoja de trabajo de segmentación: Aplicar imágenes a hojas de cálculo específicas por nombre o índice, o a todas las hojas de cálculo.
- Personalización de márgenesConfigure los márgenes superior, inferior, izquierdo y derecho de la página en centímetros.
- Compatibilidad con formatos de imagen: PNG, JPG, JPEGy formatos GIF
REST API Punto final
El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de encabezado/pie de página de imagen para Excel se realizan a través de un único punto final:
- Método: POST
- Punto final:
office/ApiV2Excel/ExcelAddImageHeaderFooter
REST API Parámetros
Importante: Los parámetros marcados con un asterisco (*) son obligatorios. Todas las solicitudes utilizan documento, docContent, contenido de la imagen (nivel raíz), y AgregarImagenEncabezadoPieDePieALaAcciónDeExcel. Otras opciones son propiedades del objeto de acción.
Parámetros requeridos (nivel raíz)
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| documento* | Object | Referencia del documento. Debe contener Nombre (cadena): Excel Nombre del archivo con extensión .xlsx o .xls | { "Name": "data.xlsx" } |
| docContent* | String (Base64) | Excel contenido del documento codificado en Base64 | UEsDBBQABgAIAAAA... |
| contenido de la imagen* | String (Base64) | Contenido del archivo de imagen codificado en Base64. Soportes PNG, JPG, JPEGformatos GIF | iVBORw0KGgoAAAANS... |
| AgregarImagenEncabezadoPieDePieALaAcciónDeExcel* | Object | Configuración de la acción (posición, selección de la hoja de cálculo, márgenes, etc.) | Consulte el ejemplo de carga útil a continuación. |
Parámetros opcionales (dentro de addImageHeaderFooterToExcelAction)
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| esEncabezado | Boolean | Selección de puestos. true = Agregar imagen al encabezado del documento (predeterminado), false = Agregar imagen al pie del documento | true |
| posición | String | Alineación horizontal dentro del encabezado/pie de página. Izquierda, Centro, o BienValor predeterminado: "Center". No distingue entre mayúsculas y minúsculas. | Center |
| nombres de las hojas de cálculo | Array (cadena[]) | Matriz de nombres de hojas de cálculo a las que se aplicará la imagen. Si tanto worksheetNames como worksheetIndexes están vacíos, se aplicará a todas las hojas de cálculo. | ["Sheet1", "Report"] |
| Índices de la hoja de trabajo | Array (int[]) | Matriz de índices de hojas de cálculo (basada en 1). Si tanto worksheetNames como worksheetIndexes están vacíos, se aplica a todas las hojas de cálculo. | [1, 2] |
| margen superior | Número (doble) | Margen superior de la página en centímetros. Valor predeterminado: 1,9 | 1.9 |
| margen inferior | Número (doble) | Margen inferior de la página en centímetros. Valor predeterminado: 1,9 | 1.9 |
| margen izquierdo | Número (doble) | Margen izquierdo de la página en centímetros. Valor predeterminado: 1,9 | 1.9 |
| margen derecho | Número (doble) | Margen derecho de página en centímetros. Valor predeterminado: 1,9 | 1.9 |
| Nombre de la cultura | String | Código cultural para el procesamiento de documentos (por ejemplo, "en-US", "de-DE", "fr-FR") | en-US |
Nota: Si ambos nombres de las hojas de cálculo y Índices de la hoja de trabajo están vacías o nulas, la imagen se aplicará a todas las hojas de cálculo en la Excel archivo.
Producción
El PDF4me Agregar imagen al encabezado y pie de página REST API devuelve el Excel documento como un Base64cadena codificada en JSON formato, no como datos binarios.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Procesamiento síncrono (predeterminado)
El API procesa la solicitud y devuelve:
Código de estado: 200 OK
Content-Type: application/json
Cuerpo de la respuesta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
Campos de respuesta:
- documento (cadena): El Excel documento con encabezado/pie de página de imagen aplicado, codificado como Base64 cadena
- Nombre del archivo (cadena): La salida Excel Nombre del archivo
- éxito (booleano): Indica si la solicitud se realizó correctamente.
- mensaje de error (cadena o nulo): Detalles del error cuando el éxito es falso.
Cómo usarlo:
- Extraer el
documentcampo del JSON respuesta (Base64) - Decodifica el Base64 cadena para obtener el binario Excel datos del documento
- Guardar o procesar el Excel Archivo según sea necesario
Ejemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const excelBytes = atob(data.document); // Decode Base64
// Save or process excelBytes
Procesamiento asíncrono
Comportamiento asíncrono (202 Accepted con sondeo) se controla mediante la configuración del servidor, no mediante un parámetro del cuerpo de la solicitud. Cuando está habilitado, el API puede devolver un estado 202 con una encuesta URL en el Location encabezado. Sondear el URL con GET solicitudes hasta que reciba 200 OK con la misma estructura de respuesta (documento, nombre de archivo, éxito, mensaje de error).
Respuestas de error
El API devuelve estándar HTTP Códigos de error con detalles del error:
- Parámetros de solicitud no válidos
- Faltan campos obligatorios (
documentoconNombre,docContent,contenido de la imagen,AgregarImagenEncabezadoPieDePieALaAcciónDeExcel) - Inválido Base64 codificación en
docContentocontenido de la imagen - Inválido o corrupto Excel documento
- Archivo de imagen no válido o dañado
- Selección de hoja de cálculo no válida (los nombres o índices no existen o están fuera de rango).
- Inválido o faltante API llave
- API La llave no funciona correctamente. Base64 codificado en Authorization encabezado
- Desaparecido
Autorización: Básicaencabezado
- Error de procesamiento del servidor
- Excel fallo en el procesamiento de documentos
- Error al agregar el encabezado/pie de página de la imagen
Formato de respuesta de error:
{
"error": "Error message describing what went wrong"
}
Detalles del formato de respuesta
Importante: El API siempre regresa JSON, nunca binario Excel datos directamente.
Estructura de respuesta:
{
"document": "string", // Base64-encoded Excel document content
"fileName": "string", // Output Excel filename
"success": true,
"errorMessage": "string or null"
}
Decodificación Base64 a Excel Documento:
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);
Ejemplo de solicitud
Encabezamiento
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota:
- Consigue tu API clave del PDF4me Panel
- El API La clave debe ser Base64 codificado y prefijado con "Basic" en el Authorization encabezado
- Ejemplo: Si su API La clave es
abc123, codificarlo a Base64 y usarAuthorization: Basic YWJjMTIz
Carga útil
Ejemplo básico (solo campos obligatorios):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {}
}
Ejemplo avanzado (con todos los campos opcionales):
{
"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"
}
}
Ejemplos de código
El PDF4me Agregar imagen de encabezado y pie de página a Excel REST API Proporciona ejemplos de código en varios lenguajes de programación. Elija el lenguaje que mejor se adapte a su entorno de desarrollo:
- C#
- Java
- JavaScript
- Python
C# (CSharp) Muestra
Completo C# implementación para agregar encabezados/pies de imagen a Excel documentos:
Java Muestra
Java Implementación con manejo completo de errores y procesamiento de respuestas:
JavaScript Muestra
Node.js y compatible con navegadores JavaScript implementación:
Casos de uso y aplicaciones en la industria
- Finance & Accounting
- Sales & Marketing
- Human Resources
- Operations & Manufacturing
- Healthcare & Medical
- Legal & Professional Services
Casos de uso de finanzas y contabilidad
- Estados financieros: Agregar encabezados con el logotipo de la empresa a los informes trimestrales
- Informes presupuestarios: Insertar los logotipos de los departamentos en las hojas de cálculo del presupuesto.
- Documentos de auditoría: Aplicar marcas de agua con el logotipo de la firma auditora en los pies de página.
- Informes de gastos: Añadir encabezados con el logotipo corporativo para las solicitudes de gastos.
Casos de uso de ventas y marketing
- Informes de ventas: Incluir los logotipos de la marca de la empresa en los informes de ventas semanales.
- Hojas de precios: Agregar encabezados con logotipos a los documentos de precios para clientes
- Informes de marketingAplicar logotipos de campaña a los informes analíticos
- Presentaciones a clientes: Añadir logotipos de marca compartida del cliente a los entregables.
Casos de uso de recursos humanos
- Informes de nómina: Insertar encabezados con el logotipo de la empresa en los documentos de nómina
- Registros de empleados: Agregar el logotipo del departamento de RRHH a las plantillas de personal
- Inscripción a beneficios: Aplicar los logotipos de los proveedores de beneficios a las hojas de inscripción
- Evaluaciones de desempeño: Añadir la imagen corporativa a las plantillas de reseñas
Casos de uso de operaciones y fabricación
- Informes de inventario: Insertar los logotipos de las ubicaciones de los almacenes en las hojas de inventario.
- Informes de producción: Agregar logotipos de plantas de producción a los informes de fabricación.
- Informes de calidad: Aplicar logotipos de certificación de calidad en los encabezados
- Informes de la cadena de suministro: Agregar logotipos de proveedores a los documentos de adquisición
Casos de uso en el sector sanitario y médico
- Informes de pacientes: Agregar encabezados con el logotipo del hospital o la clínica a los datos del paciente.
- Resultados de laboratorio: Incluir el logotipo del laboratorio en las hojas de resultados de las pruebas.
- Reclamaciones de seguros: Aplicar los logotipos de las compañías aseguradoras a los documentos de reclamación.
- Registros médicos: Añadir la imagen corporativa del centro a las hojas informativas sobre salud.
Casos de uso de servicios legales y profesionales
- Informes de clientes: Insertar encabezados con el logotipo del bufete de abogados en los entregables para el cliente.
- Documentos del caso: Agregar logotipos de áreas de práctica a los expedientes de casos legales
- Plantillas de contratosAplicar la imagen corporativa a las hojas de trabajo de los contratos.
- Estados de cuenta: Insertar el logotipo de la empresa en los informes de facturación legal