Agregar texto al encabezado y pie de página - Excel API
PDF4me Agregar texto al encabezado y pie de página te permite agregar encabezados y pies de página de texto personalizables a Excel documentos con control de formato integral. API procesos de servicio Excel archivos y agrega texto a las secciones de encabezado o pie de página con estilos de fuente (familia, tamaño, color), niveles de transparencia, ángulos de rotación y opciones de orientación (horizontal, vertical, diagonal, invertida). API recibe Excel contenido del documento a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Esta solución es ideal para la personalización de documentos, numeración de páginas, fechas y flujos de trabajo de presentaciones profesionales.
Autenticando su API Pedido
Incluye tu API clave en la solicitud para autenticarse con el PDF4me REST API.
Características principales
- Contenido de texto personalizado: Agregue cualquier texto como encabezado o pie de página en Excel documentos
- Personalización de fuentes: Controla la familia de fuentes, el tamaño, el color y los nombres de fuentes específicos.
- Control de transparencia: Establecer texto semitransparente (50% de opacidad) o totalmente opaco (100%)
- Rotación y orientación: Aplicar ángulos de rotación u orientaciones preestablecidas (horizontal, vertical, diagonal, invertida)
- Apoyo culturalEspecifique los códigos de cultura para una correcta representación y formato del texto.
REST API Punto final
- Método: POST
- Punto final:
office/ApiV2Excel/ExcelAddTextHeaderFooter
REST API Parámetros
Importante: Los parámetros marcados con un asterisco (*) son obligatorios. Todas las solicitudes utilizan documento, docContenty un objeto de acción. Los parámetros específicos de la operación son propiedades de Agregar textoEncabezadoPieDePieAExcelAction.
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... |
| Agregar textoEncabezadoPieDePieAExcelAction* | Object | Configuración de acción. Debe contener al menos texto de marca de agua (cadena): texto que se mostrará como encabezado o pie de página | Consulte el ejemplo de carga útil a continuación. |
Parámetros opcionales (dentro de addTextHeaderFooterToExcelAction)
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| familia de fuentes | String | Nombre de la familia tipográfica (p. ej., Arial, Times New Roman). Predeterminado: Arial | Arial |
| tamaño de fuente | Número | Tamaño de fuente en puntos (8-72). Predeterminado: 72 | 12 |
| color de fuente | String | Código hexadecimal o nombre del color. Predeterminado: negro | #0000FF |
| semiTransparente | Boolean | verdadero = 50% de opacidad, falso = 100% (predeterminado) | false |
| rotación | Número | Ángulo de rotación en grados (0-360). Valor predeterminado: 0 | 45 |
| nombre de fuente | String | Nombre de fuente específico (anula fontFamily) | Arial Bold |
| orientación | String | Horizontal, Vertical, Diagonal, o Al revésTiene prioridad sobre la rotación. | Horizontal |
| Nombre de la cultura | String | Código cultural para la representación del texto (por ejemplo, "en-US", "de-DE") | en-US |
Producción
El API devuelve el Excel documento como un Base64cadena codificada en JSON formato.
- Success Response
- Error Responses
Código de estado: 200 OK
Cuerpo de la respuesta:
{
"document": "UEsDBBQABgAIAAAA...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
400 Bad Request: Parámetros no válidos, campos obligatorios faltantes, no válido Base64 o documento. 401 Unauthorized: Inválido o faltante API llave. 500 Internal Server Error: Error de procesamiento del servidor.
Ejemplo de solicitud
Encabezamiento
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Carga útil (básica)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024"
}
}
Carga útil (con formato opcional)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024",
"fontFamily": "Arial",
"fontSize": 12,
"fontColor": "#0000FF",
"orientation": "Horizontal"
}
}
Ejemplos de código
- GitHub