Agregar HTML Encabezado Pie de página a PDF - Imagen de marca API

PDF4me Agregar HTML Encabezado Pie de página a PDF te permite agregar HTML contenido como encabezados, pies de página o ambos PDF documentos. Este API procesos de servicio PDF archivos y agrega HTML Contenido con posicionamiento preciso, márgenes personalizados y opciones de segmentación de página para la organización y personalización del documento. API recibe PDF contenido y HTML datos a través de REST API llamadas, utilizando Base64 codificación para seguridad PDF transmisión. Con soporte para HTML Con contenido, posicionamiento flexible, márgenes personalizados, segmentación de páginas y exclusión de la primera página, esta solución es ideal para la personalización de documentos, la generación de informes y la gestión empresarial. PDF flujos de trabajo.

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

• HTML Soporte de contenido: Agregar riqueza HTML Contenido como encabezados y pies de página con soporte completo para estilos.
• Posicionamiento flexibleControla la posición del encabezado y el pie de página con un control de margen preciso.
• Estilo personalizado: Lleno HTML y CSS apoyo para una apariencia profesional
• Segmentación de páginas: Aplicar encabezados y pies de página a páginas específicas o a documentos completos.
• Saltar la primera páginaOpción para excluir encabezados y pies de página de la primera página.
• Resultados profesionales: Crea encabezados y pies de página que mejoren la organización y la imagen de marca del documento.
• Sin fisuras API Integración: REST API diseñado para automatización PDF flujos de trabajo de edición e integración de sistemas empresariales

REST API Punto final

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

• Método: POST
• Punto final: /api/v2/AddHtmlHeaderFooter

Características del encabezado y del pie de página

HTML Soporte de contenido

• HTML Contenido: Soporte para HTML contenido con inline CSS estilismo
• Estilo personalizado: Usar en línea CSS para fuentes, colores, alineación y estilo básico
• Texto e imágenes: Soporte para HTML contenido de texto e imágenes incrustadas
• Plano HTML Cadena: HTML El contenido debe proporcionarse como una cadena simple (no Base64 codificado)

Posicionamiento y diseño

• Control de márgenes: Posicionamiento preciso con mediciones basadas en píxeles (margen izquierdo, margen derecho, margen superior, margen inferior)
• Segmentación de páginas: Aplicar a páginas específicas usando opciones de página (cadena vacía para todas las páginas, "1", "1,3,5", "2-5", "1,3,7-10", "2-")
• Saltar la primera páginaOpción para excluir encabezados y pies de página de la primera página.
• Opciones de ubicación: Agregue contenido como encabezado, pie de página o ambos.

Características avanzadas

• Procesamiento asíncrono: Compatibilidad con el procesamiento asíncrono mediante sondeo para operaciones de larga duración.
• Apariencia profesionalFormato y estilo uniformes en todos los documentos.
• Posicionamiento flexibleControla la ubicación del encabezado y el pie de página con medidas exactas en píxeles.

REST API Parámetros

Lista completa de parámetros para la función Agregar HTML Encabezado Pie de página a PDF 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 y deben proporcionarse para la API para que funcione correctamente.

Parámetros requeridos

Parámetro	Tipo	Descripción	Ejemplo
Nombre del documento*	String	Producción PDF Nombre del archivo con extensión .pdf	output.pdf
docContent*	Base64	El contenido de la entrada PDF archivo codificado en Base64	JVBERi...
htmlContent*	String	HTML contenido (plano) HTML cadena (NO codificada en base64) para agregar como encabezado o pie de página	<div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div>
ubicación*	String	Ubicación para HTML contenido: Encabezamiento, Pie de página, o Ambos	Header

Parámetros opcionales

Parámetro	Tipo	Descripción	Ejemplo
páginas	String	Opciones de página: cadena vacía para todas las páginas, "1" para la página 1, "1,3,5" para páginas específicas, "2-5" para rango de páginas, "1,3,7-10" para mixto, "2-" para las páginas del 2 al final	"" o "1-3"
skipFirstPage	Boolean	Omitir la primera página (verdadero) o incluir la primera página (falso)	false
margen izquierdo	Doble	Margen izquierdo en píxeles	20.0
margenDerecha	Doble	Margen derecho en píxeles	20.0
margen superior	Doble	Margen superior en píxeles	50.0
margen inferior	Doble	Margen inferior en píxeles	50.0
asíncrono	Boolean	Habilitar el procesamiento asíncrono. Cuando true, el API devuelve un estado 202 y proporciona una encuesta URL en el Location encabezado	true

Nota importante: El htmlContent El parámetro debe ser un plano HTML cadena, no Base64 codificado. Puede incluir en línea. CSS estilismo dentro del HTML.

Producción

El PDF4me Agregar HTML Encabezado Pie de página a PDF REST API devuelve diferentes respuestas según el modo de procesamiento. API devuelve el PDF como un Base64cadena codificada en JSON formato, no como datos binarios.

Success Response

Procesamiento síncrono (predeterminado)

Cuando async no está configurado o está configurado false, el API procesa la solicitud inmediatamente:

Código de estado: 200 OK

Content-Type: application/json

Cuerpo de la respuesta:

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}

Campos de respuesta:

• Nombre del documento (cadena): La salida PDF Nombre del archivo
• docContent (cadena): El PDF archivo con HTML encabezado/pie de página aplicado, codificado como Base64 cadena

Cómo usarlo:

1. Extraer el docContent campo del JSON respuesta
2. Decodifica el Base64 cadena para obtener el binario PDF datos
3. Guardar o procesar el PDF Archivo según sea necesario

Ejemplo (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes

Asynchronous Processing

Procesamiento asíncrono

Cuando async: true está establecido, el API procesa la solicitud de forma asíncrona:

Código de estado: 202 Accepted

Encabezados de respuesta:

Location: https://api.pdf4me.com/api/v2/AddHtmlHeaderFooter/poll/12345-abcde-67890

Proceso de votación:

1. Extraer el Location encabezado de la respuesta 202
2. Encuesta la URL usando GET solicitudes
3. Continúe realizando encuestas hasta que reciba una 200 OK estado
4. La respuesta final contiene lo mismo JSON formato con docName y docContent (Base64)

Ejemplo de encuesta:

// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');

// Poll until complete
while (true) {
  const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
  if (pollResponse.status === 200) {
    const data = await pollResponse.json();
    // Process data.docContent (Base64 PDF)
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

Respuestas de error

El API devuelve estándar HTTP Códigos de error con detalles del error:

400 Bad Request

• Parámetros de solicitud no válidos
• Faltan campos obligatorios (Nombre del documento, docContent, htmlContent, ubicación)
• Inválido Base64 codificación en docContent
• Valor de ubicación no válido (debe ser: Encabezado, Pie de página o Ambos)
• Inválido HTML contenido

401 Unauthorized

• Inválido o faltante API llave
• API La llave no funciona correctamente. Base64 codificado en Authorization encabezado
• Desaparecido Autorización: Básica encabezado

500 Internal Server Error

• Error de procesamiento del servidor
• PDF fallo de procesamiento
• HTML fallo de renderizado

Formato de respuesta de error:

{
  "error": "Error message describing what went wrong"
}

Response Format Details

Detalles del formato de respuesta

Importante: El API siempre regresa JSON, nunca binario PDF datos directamente.

Estructura de respuesta:

{
  "docName": "string",      // Output PDF filename
  "docContent": "string"    // Base64-encoded PDF content
}

Content-Type Encabezado:

• Éxito: application/json
• El PDF está incrustado como un Base64 cadena dentro de la JSON respuesta

Por qué Base64¿

• JSON-Codificación segura para datos binarios
• Fácil de transmitir HTTP
• Compatible con todos los lenguajes de programación.
• Se puede integrar directamente en JSON sin escapar de los problemas

Decodificación Base64 a PDF:

JavaScript/Node.js:

const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js

Python:

import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
    f.write(pdf_bytes)

C#:

byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);

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 (solo campos obligatorios):

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header"
}

Ejemplo avanzado (con todos los campos opcionales):

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header",
  "pages": "",
  "skipFirstPage": false,
  "marginLeft": 20.0,
  "marginRight": 20.0,
  "marginTop": 50.0,
  "marginBottom": 50.0,
  "async": true
}

Importante: El htmlContent El campo debe contener plano HTML como una cadena, no Base64 codificado. Puedes usar en línea. CSS estilismo dentro del HTML etiquetas.

Ejemplos de código

El PDF4me Agregar HTML Encabezado Pie de página a PDF 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#

C# (CSharp) Muestra

Completo C# implementación para agregar encabezados y pies de página a PDF:

View C# Sample

Java

Java Muestra

Java Implementación con manejo completo de errores y procesamiento de respuestas:

View Java Sample

JavaScript

JavaScript Muestra

Node.js y compatible con navegadores JavaScript implementación:

View JavaScript Sample

Python

Python Muestra

Python implementación con la biblioteca requests y JSON manejo:

View Python Sample

Salesforce

Salesforce Muestra

Salesforce Apex implementación para CRM integración:

View Salesforce Sample

n8n

n8n Muestra

n8n Implementación de flujos de trabajo para la automatización:

View n8n Sample

Google Script

Google Script Muestra

Google Apps Script implementación para Google Workspace integración:

View Google Script Sample

AWS Lambda

AWS Lambda Muestra

Sin servidor AWS Lambda Implementación de la función:

View AWS Lambda Sample

Casos de uso y aplicaciones en la industria

Legal & Professional Services

Casos de uso de servicios legales y profesionales

• Documentación legal: Aplicar cláusulas de exención de responsabilidad y avisos de confidencialidad a los documentos legales.
• Encabezados de contrato: Agregar encabezados y pies de página a los contratos y acuerdos
• Documentación de cumplimientoIncluir avisos de cumplimiento en los encabezados y pies de página.
• Documentación del cliente: Añadir encabezados y pies de página profesionales a los documentos de los clientes.

Business & Enterprise

Casos de uso para empresas y negocios

• Marca de documentos: Agregar logotipos de la empresa, encabezados y pies de página a documentos PDF
• Generación de informes: Agregar encabezados y pies de página consistentes a los informes generados
• Documentos comerciales: Mejora la apariencia profesional con encabezados y pies de página personalizados con tu marca.
• Imagen corporativaAplicar encabezados y pies de página uniformes en todos los documentos comerciales.

Education & Research

Casos de uso en educación e investigación

• Artículos académicosAgregar números de página, encabezados y pies de página a las publicaciones académicas.
• Documentos de investigaciónFormatee los trabajos de investigación con encabezados y pies de página adecuados.
• Formato de tesis: Añadir encabezados y pies de página a tesis y disertaciones
• Materiales educativos: Mejora los documentos educativos con encabezados y pies de página.

Finance & Banking

Casos de uso en finanzas y banca

• Informes financieros: Agregar encabezados y pies de página a los informes y estados financieros.
• Formato de factura: Aplicar encabezados y pies de página a las facturas y documentos financieros.
• Documentación de cumplimientoIncluir información de cumplimiento en los encabezados y pies de página.
• Informes de auditoría: Añadir encabezados y pies de página profesionales a los informes de auditoría

Obtén ayuda

Get Your API KeyAPI SamplesGetting Started