Adicionar HTML Cabeçalho Rodapé para PDF - Branding API

PDF4me Adicionar HTML Cabeçalho Rodapé para PDF permite que você adicione HTML conteúdo como cabeçalhos, rodapés ou ambos para PDF documentos. Isto API processos de serviço PDF arquivos e adições HTML Conteúdo com posicionamento preciso, margens personalizadas e opções de direcionamento de página para identidade visual e organização do documento. API recebe PDF conteúdo e HTML dados através de REST API chamadas, utilizando Base64 codificação para segurança PDF transmissão. Com suporte para HTML Com conteúdo, posicionamento flexível, margens personalizadas, segmentação de páginas e exclusão da primeira página, esta solução é ideal para personalização de documentos, geração de relatórios e aplicações corporativas. PDF fluxos de trabalho.

Artigos relacionados no blogue

Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.

Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.

Visite o blogue →

Autenticando seu API Solicitar

Para acessar o PDF4me REST APIPara que uma solicitação seja aceita, é necessário incluir as credenciais de autenticação adequadas. A autenticação garante a segurança da comunicação e valida sua identidade como usuário autorizado do sistema. REST API.

Get your api Key

Principais características

• HTML Suporte de conteúdoAdicione riqueza HTML Conteúdo como cabeçalhos e rodapés com suporte completo a estilos.
• Posicionamento flexívelControle o posicionamento do cabeçalho e rodapé com precisão no controle de margens.
• Estilização personalizada: Completo HTML e CSS apoio para uma aparência profissional
• Segmentação de páginaAplicar cabeçalhos e rodapés a páginas específicas ou a documentos inteiros.
• Pular para a primeira páginaOpção para excluir cabeçalhos e rodapés da primeira página.
• Resultados profissionaisCrie cabeçalhos e rodapés que aprimorem a organização e a identidade visual do documento.
• Sem costura API Integração: REST API projetado para automatizado PDF fluxos de trabalho de edição e integração de sistemas empresariais

REST API Ponto final

O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de adição de cabeçalho e rodapé são realizadas por meio de um único ponto de extremidade:

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

Características do cabeçalho e rodapé

HTML Suporte de conteúdo

• HTML ContenteSuporte para HTML conteúdo com conteúdo embutido CSS estilo
• Estilização personalizada: Usar em linha CSS para fontes, cores, alinhamento e estilo básico.
• Texto e imagensSuporte para HTML conteúdo de texto e imagens incorporadas
• Simples HTML Corda: HTML O conteúdo deve ser fornecido como uma string simples (não Base64 codificado)

Posicionamento e Layout

• Controle de MargemPosicionamento preciso com medições baseadas em pixels (margem esquerda, margem direita, margem superior, margem inferior)
• Segmentação de páginaAplicar a páginas específicas usando opções de página (string vazia para todas as páginas, "1", "1,3,5", "2-5", "1,3,7-10", "2-")
• Pular para a primeira páginaOpção para excluir cabeçalhos e rodapés da primeira página.
• Opções de localizaçãoAdicione conteúdo como cabeçalho, rodapé ou ambos.

Recursos avançados

• Processamento assíncronoSuporte para processamento assíncrono com polling para operações de longa duração.
• Aparência profissionalFormatação e estilo consistentes em todos os documentos.
• Posicionamento flexívelControle o posicionamento do cabeçalho e rodapé com medições exatas em pixels.

REST API Parâmetros

Lista completa de parâmetros para o Adicionar HTML Cabeçalho Rodapé para PDF REST APIOs parâmetros estão organizados por categoria para melhor compreensão e implementação.

Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios e devem ser fornecidos para o API para funcionar corretamente.

Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Exemplo
nomeDoDocumento*	String	Saída PDF nome do arquivo com extensão .pdf	output.pdf
conteúdo do documento*	Base64	O conteúdo da entrada PDF arquivo codificado em Base64	JVBERi...
Conteúdo HTML*	String	HTML conteúdo (simples) HTML string (NÃO codificada em base64) para ser adicionada como cabeçalho ou rodapé	<div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div>
localização*	String	Localização para HTML contente: Cabeçalho, Rodapé, ou Ambos	Header

Parâmetros opcionais

Parâmetro	Tipo	Descrição	Exemplo
páginas	String	Opções da página: texto vazio para todas as páginas. "1" para a página 1, "1,3,5" para páginas específicas, "2-5" para intervalo de páginas, "1,3,7-10" para misto, "2-" para as páginas de 2 até o final	"" ou "1-3"
pularPrimeiraPágina	Boolean	Ignorar a primeira página (verdadeiro) ou incluir a primeira página (falso)	false
margemEsquerda	Dobro	Margem esquerda em pixels	20.0
margemDireita	Dobro	Margem direita em pixels	20.0
margem superior	Dobro	Margem superior em pixels	50.0
margemInferior	Dobro	Margem inferior em pixels	50.0
assíncrono	Boolean	Ative o processamento assíncrono. Quando true, o API retorna o status 202 e fornece uma opção de sondagem. URL no Location cabeçalho	true

Nota importante: O htmlContent O parâmetro deve ser um simples HTML corda, não Base64 codificado. Você pode incluir em linha CSS estilização dentro do HTML.

Saída

O PDF4me Adicionar HTML Cabeçalho Rodapé para PDF REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna o PDF como um Base64string codificada em JSON formato, não como dados binários.

Success Response

Processamento síncrono (padrão)

Quando async não está definido ou está definido como false, o API processa a solicitação imediatamente:

Código de status: 200 OK

Content-Type: application/json

Corpo da resposta:

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

Campos de resposta:

• nomeDoDocumento (string): A saída PDF nome do arquivo
• conteúdo do documento (string): O PDF arquivo com HTML Cabeçalho/rodapé aplicado, codificado como Base64 corda

Como usar:

1. Extraia o docContent campo do JSON resposta
2. Decifre o Base64 string para obter o binário PDF dados
3. Salvar ou processar o PDF arquive conforme necessário

Exemplo (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

Processamento assíncrono

Quando async: true está definido, o API processa a solicitação de forma assíncrona:

Código de status: 202 Accepted

Cabeçalhos de resposta:

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

Processo de votação:

1. Extraia o Location cabeçalho da resposta 202
2. Faça a pesquisa URL usando GET solicitações
3. Continue votando até receber um 200 OK status
4. A resposta final contém o mesmo JSON formato com docName e docContent (Base64)

Exemplo de votação:

// 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

Respostas de erro

O API retorna padrão HTTP Códigos de erro com detalhes do erro:

400 Bad Request

• Parâmetros de solicitação inválidos
• Campos obrigatórios ausentes (nomeDoDocumento, conteúdo do documento, Conteúdo HTML, localização)
• Inválido Base64 codificação em conteúdo do documento
• Valor de localização inválido (deve ser: Cabeçalho, Rodapé ou Ambos)
• Inválido HTML contente

401 Unauthorized

• Inválido ou ausente API chave
• API chave não está corretamente Base64 codificado em Authorization cabeçalho
• Ausente Autorização: Básica cabeçalho

500 Internal Server Error

• Erro de processamento no servidor
• PDF falha de processamento
• HTML falha de renderização

Formato da resposta de erro:

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

Response Format Details

Detalhes do formato da resposta

Importante: O API sempre retorna JSON, nunca binário PDF dados diretamente.

Estrutura da resposta:

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

Content-Type Cabeçalho:

• Sucesso: application/json
• O PDF está incorporado como um Base64 string dentro do JSON resposta

Por que Base64?

• JSON-Codificação segura para dados binários
• Fácil de transmitir HTTP
• Compatível com todas as linguagens de programação.
• Pode ser incorporado diretamente em JSON sem escapar dos problemas

Decodificando Base64 para 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);

Exemplo de solicitação

Cabeçalho

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Observação:

• Adquira o seu API chave do PDF4me Painel
• O API a chave deve ser Base64 codificado e prefixado com "Básico" no Authorization cabeçalho
• Exemplo: Se o seu API chave é abc123, codifique-o para Base64 e usar Authorization: Basic YWJjMTIz

Carga útil

Exemplo básico (somente campos obrigatórios):

{
  "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"
}

Exemplo avançado (com todos os campos opcionais):

{
  "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: O htmlContent O campo deve conter simples HTML como uma string, não Base64 codificado. Você pode usar inline CSS estilização dentro do HTML etiquetas.

Exemplos de código

O PDF4me Adicionar HTML Cabeçalho Rodapé para PDF REST API Fornece exemplos de código em várias linguagens de programação. Escolha a linguagem que melhor se adapta ao seu ambiente de desenvolvimento:

C#

C# (CSharp) Exemplo

Completo C# Implementação para adicionar cabeçalhos e rodapés a PDF:

View C# Sample

Java

Java Amostra

Java Implementação com tratamento completo de erros e processamento de respostas:

View Java Sample

JavaScript

JavaScript Amostra

Node.js e compatível com navegadores JavaScript Implementação:

View JavaScript Sample

Python

Python Amostra

Python implementação com a biblioteca requests e JSON manuseio:

View Python Sample

Salesforce

Salesforce Amostra

Salesforce Apex implementação para CRM integração:

View Salesforce Sample

n8n

n8n Amostra

n8n Implementação de fluxo de trabalho para automação:

View n8n Sample

Google Script

Google Script Amostra

Google Apps Script implementação para Google Workspace integração:

View Google Script Sample

AWS Lambda

AWS Lambda Amostra

Sem servidor AWS Lambda Implementação da função:

View AWS Lambda Sample

Casos de uso e aplicações industriais

Legal & Professional Services

Casos de uso de serviços jurídicos e profissionais

• Documentação LegalAplicar avisos legais de isenção de responsabilidade e confidencialidade a documentos jurídicos.
• Cabeçalhos de contratoAdicionar cabeçalhos e rodapés a contratos e acordos
• Documentação de ConformidadeIncluir avisos de conformidade nos cabeçalhos e rodapés.
• Documentação do ClienteAdicione cabeçalhos e rodapés profissionais aos documentos do cliente.

Business & Enterprise

Casos de uso para empresas e negócios

• Identidade Visual de DocumentosAdicionar logotipos, cabeçalhos e rodapés da empresa a documentos PDF
• Geração de relatóriosAdicionar cabeçalhos e rodapés consistentes aos relatórios gerados
• Documentos comerciaisMelhore a aparência profissional com cabeçalhos e rodapés personalizados com a sua marca.
• Identidade Visual CorporativaAplicar cabeçalhos e rodapés consistentes em todos os documentos comerciais.

Education & Research

Casos de uso em educação e pesquisa

• Artigos acadêmicosAdicionar números de página, cabeçalhos e rodapés a publicações acadêmicas.
• Documentos de pesquisaFormate os trabalhos de pesquisa com cabeçalhos e rodapés adequados.
• Formatação de teseAdicionar cabeçalhos e rodapés a teses e dissertações
• Materiais EducacionaisMelhore os documentos educacionais com cabeçalhos e rodapés.

Finance & Banking

Casos de uso em finanças e bancos

• Relatórios financeirosAdicionar cabeçalhos e rodapés a relatórios e demonstrações financeiras.
• Formatação de faturasAplicar cabeçalhos e rodapés a faturas e documentos financeiros.
• Documentação de ConformidadeInclua informações de conformidade nos cabeçalhos e rodapés.
• Relatórios de auditoriaAdicione cabeçalhos e rodapés profissionais aos relatórios de auditoria.

Obtenha ajuda

Get Your API KeyAPI SamplesGetting Started