Saltar al contenido principal
PDF4me APIIntegracionesBase de conocimientosExtensionesProbador de APIBlog

Actualizar encabezados y pies de página - Gestión de encabezados API

PDF4me Actualizar encabezados y pies de página Le permite agregar o modificar encabezados y pies de página en documentos de Word con una funcionalidad completa. HTML Soporte de contenido y opciones de estilo profesional. API El servicio procesa archivos de Word y aplica encabezados y pies de página a diferentes diseños de página, incluyendo la primera página, páginas pares/impares y todas las páginas con aplicación automática de estilos profesionales predeterminados, HTML procesamiento de contenido y formato flexible específico de página. API recibe el contenido del documento de Word a través de REST API llamadas, utilizando Base64 codificación para transmisión segura. Con soporte para campos de número de página (PAGE, NUMPAGES, SECTION, SECTIONPAGES), HTML Gracias a su formato y estilo profesional automático, esta solución es ideal para la personalización de documentos, la numeración de páginas y los flujos de trabajo de presentación profesional de documentos.

Entradas de blog relacionadas
Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.
Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.
Visita el blog →

Autenticando su API Pedido​

Para acceder al PDF4me REST APICada solicitud debe incluir las credenciales de autenticación adecuadas. La autenticación garantiza una comunicación segura y valida su identidad como usuario autorizado del sistema. REST API.

Get your api Key

Características principales​

  • Varios tipos de página: Compatibilidad con todas las páginas, primera página, páginas pares/impares
  • HTML Soporte de contenido: Rico HTML contenido con estilo profesional
  • Estilo automáticoEstilo profesional predeterminado para contenido de texto sin formato
  • Campos de número de página: Soporte para PAGE, NUMPAGES, SECTION, SECTIONPAGES
  • Diseño flexible: Encabezados/pies de página diferentes para distintos tipos de página
  • Apoyo culturalProcesamiento de documentos específico de la configuración regional
  • Preservación del formatoMantiene la estructura original del documento.
  • Apariencia profesionalAplicación automática de estilismo profesional

REST API Punto final​

El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de actualización de encabezado y pie de página se realizan a través de un único punto final:

  • Método: POST
  • Punto final: office/ApiV2Word/UpdateHeadersAndFooters

REST API Parámetros​

Lista completa de parámetros para la actualización de encabezados y pies de página. REST APILos parámetros están organizados por categoría para una mejor comprensión e implementación.

Importante: Los parámetros marcados con un asterisco (*) son obligatorios. Los parámetros avanzados permiten un control preciso de los encabezados y pies de página específicos de cada página.

Parámetros requeridos​

ParámetroTipoDescripciónEjemplo
documento*ObjectDescripción del documento. Debe incluir Nombre (string): generar el nombre del archivo de Word con extensión .docx{ "Name": "document.docx" }
docContent*Base64Contenido del documento de Word codificado en Base64Se han añadido encabezados y pies de página a este documento. Debe ser un documento de Word válido (formatos .docx o .doc).base64EncodedDocumentContent

Parámetros opcionales (encabezado/pie de página) HTML)​

ParámetroTipoDescripciónEjemplo
encabezadoContenidoStringContenido de encabezado simple (utilizado con footerContent cuando el formato del control es isHtml/isHtmlMode)"Company Name"
Contenido del pie de páginaStringContenido simple del pie de página"Page PAGE of NUMPAGES"
es HTMLBooleanSi el contenido del encabezado/pie de página es HTMLtrue
isHtmlModeBooleanUsar HTML modo de procesamiento de contenidotrue
Encabezado de todas las páginas HTMLStringEncabezado HTML para todas las páginas. Compatible con PAGE, NUMPAGES, SECTION, SECTIONPAGES"<div style='text-align: center;'>Company Name</div>"
Encabezado de primera página HTMLStringEncabezado HTML Solo para la primera página"<div style='text-align: center;'>Title Page</div>"
inclusoPagesHeaderHtmlStringEncabezado HTML para páginas pares"<div style='text-align: right;'>Book Title</div>"
Encabezado de páginas imparesHtmlStringEncabezado HTML para páginas impares"<div style='text-align: left;'>Chapter Title</div>"
todasLasPáginasPieDePieHtmlStringPie de página HTML para todas las páginas"Page PAGE of NUMPAGES"
firstPageFooterHtmlStringPie de página HTML Solo para la primera página"<div style='text-align: center;'>Confidential</div>"
inclusoPagesFooterHtmlStringPie de página HTML para páginas pares"<div style='text-align: center;'>Page PAGE</div>"
Páginas imparesPieDePieHtmlStringPie de página HTML para páginas impares"<div style='text-align: center;'>Page PAGE</div>"

Parámetros opcionales (encabezado/pie de página tipificado)​

ParámetroTipoDescripciónEjemplo
Encabezado de todas las páginasObjectContenido del encabezado escrito para todas las páginas (HeaderFooterContentInUpdate)-
Encabezado de primera páginaObjectEncabezado escrito para la primera página-
Encabezado de páginas pares / Encabezado de páginas imparesObjectEncabezado escrito para páginas pares/impares-
Pie de página de todas las páginas / pie de página / inclusoPáginasPie / Páginas impares Pie de páginaObjectContenido del pie de página escrito por tipo de página-

Parámetros opcionales (generales)​

ParámetroTipoDescripciónEjemplo
Nombre de la culturaStringCódigo cultural para el procesamiento de documentos (p. ej., "en-US", "fr-FR", "de-DE"). Valor predeterminado: nulo. Afecta al idioma y al formato del documento.en-US

HTML Soporte de contenido​

El API apoya HTML Contenido en todos los parámetros de encabezado y pie de página:

  • HTML Etiquetas: Estándar HTML etiquetas (div, span, p, b, i, u, etc.)
  • Estilo CSS: Estilos CSS en línea para dar formato
  • Texto sin formatoEl texto sin formato recibe automáticamente un estilo profesional predeterminado.
  • Contenido mixto: Combinar HTML y texto plano según sea necesario

Estilo predeterminado para texto sin formato:

  • EncabezadosAlineación izquierda, borde inferior, fuente de 10px
  • Pies de página: Alineación centrada, borde superior, fuente de 9px

Opciones de diseño de página​

El API Admite diferentes diseños de página para encabezados y pies de página:

Tipo de diseñoDescripciónParámetros requeridos
Todas las páginasMismo encabezado y pie de página en todas las páginas.allPagesHeaderHtml, allPagesFooterHtml (o escrito) allPagesHeader, allPagesFooter)
Primera páginaEncabezado/pie de página diferente en la primera páginafirstPageHeaderHtml, firstPageFooterHtml (o equivalentes escritos)
Páginas pares/imparesEncabezados/pies de página diferentes para páginas pares e impares.evenPagesHeaderHtml, oddPagesHeaderHtml, evenPagesFooterHtml, oddPagesFooterHtml (o equivalentes escritos)

Producción​

El PDF4me Actualizar encabezados y pies de página REST API devuelve un JSON respuesta. En caso de éxito, API devuelve el documento de Word como un Base64cadena codificada en el document campo (ApiV2WordApiCallRes), no como datos binarios.

Respuesta de éxito

Código de estado: 200 OK

Tipo de contenido: application/json

Cuerpo de la respuesta:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

Campos de respuesta:

  • documento (string): El documento de Word con encabezados y pies de página actualizados, codificado como Base64
  • Nombre del archivo (string): El nombre del archivo de Word de salida
  • éxito (boolean): Si la operación tuvo éxito
  • mensaje de error (string): Mensaje de error si el éxito es falso; de lo contrario, nulo.

Cómo usarlo:

  1. Controlar success; si es verdadero, extraiga el document campo del JSON respuesta
  2. Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
  3. Guarde o procese el archivo de Word usando fileName

Ejemplo (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const base64 = data.document;
const binary = atob(base64);
const blob = new Blob([binary], { type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = data.fileName;
a.click();

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 usar Authorization: Basic YWJjMTIz

Carga útil​

Ejemplo básico (encabezado y pie de página en todas las páginas):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center;'>Company Name</div>",
 "allPagesFooterHtml": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

Ejemplo avanzado (primera página + páginas pares/impares):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "firstPageHeaderHtml": "<div style='text-align: center;'>Title Page</div>",
 "firstPageFooterHtml": "<div style='text-align: center;'>Confidential</div>",
 "oddPagesHeaderHtml": "<div style='text-align: left;'>Chapter Title</div>",
 "evenPagesHeaderHtml": "<div style='text-align: right;'>Book Title</div>",
 "oddPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "evenPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "cultureName": "en-US"
}

Ejemplo de contenido HTML:

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center; color: #333; font-size: 12px; border-bottom: 1px solid #ccc; padding-bottom: 5px;'>Company Name | Department</div>",
 "allPagesFooterHtml": "<div style='text-align: center; color: #666; font-size: 9px; border-top: 1px solid #ccc; padding-top: 5px;'>Page PAGE of NUMPAGES | © 2024 Company Name</div>",
 "cultureName": "en-US"
}

Ejemplo de texto plano (contenido del encabezado/contenido del pie de página):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "headerContent": "Company Name",
 "footerContent": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

Ejemplos de código​

El PDF4me Actualizar encabezados y pies de página 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# (CSharp) Muestra

Completo C# Implementación para actualizar encabezados y pies de página en documentos de Word:

Casos de uso y aplicaciones en la industria​

Casos de uso de servicios legales y profesionales

  • Encabezados de contrato: Añadir avisos de confidencialidad y exenciones de responsabilidad legales
  • Documentos judicialesIncluya los números de caso y la información de presentación.
  • Informes legales: Agregar información del abogado y detalles del caso
  • Informes de cumplimientoIncluir información reglamentaria y fechas.

Obtén ayuda​

Get Your API KeyAPI SamplesGetting Started