Atualizar cabeçalhos e rodapés - Gerenciamento de cabeçalhos API

PDF4me Atualizar cabeçalhos e rodapés Permite adicionar ou modificar cabeçalhos e rodapés em documentos do Word com recursos abrangentes. HTML Suporte de conteúdo e opções de estilo profissional. Isto API O serviço processa arquivos do Word e aplica cabeçalhos e rodapés a diferentes layouts de página, incluindo a primeira página, páginas pares/ímpares e todas as páginas, com aplicação automática de estilo padrão profissional. HTML processamento de conteúdo e formatação flexível específica da página. O API recebe conteúdo de documento Word através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para campos de número de página (PAGE, NUMPAGES, SECTION, SECTIONPAGES), HTML Com formatação e estilização profissional automática, esta solução é ideal para identidade visual de documentos, numeração de páginas e fluxos de trabalho de apresentação de documentos profissionais.

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

• Vários tipos de páginaSuporte para todas as páginas, primeira página e páginas pares/ímpares.
• HTML Suporte de conteúdo: Rico HTML conteúdo com estilo profissional
• Estilização automáticaEstilo padrão profissional para conteúdo de texto simples
• Campos de número de páginaSuporte para PAGE, NUMPAGES, SECTION, SECTIONPAGES
• Layout flexívelCabeçalhos/rodapés diferentes para tipos de página diferentes
• Apoio à CulturaProcessamento de documentos específico para cada localidade
• Preservação de FormatoMantém a estrutura original do documento.
• Aparência profissionalAplicação automática de penteados profissionais

REST API Ponto final

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

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

REST API Parâmetros

Lista completa de parâmetros para a atualização de cabeçalhos e rodapés. 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. Os parâmetros avançados oferecem controle preciso sobre os cabeçalhos e rodapés específicos de cada página.

Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Exemplo
documento*	Object	Descrição do documento. Deve incluir Nome (string): nome do arquivo Word de saída com extensão .docx	{ "Name": "document.docx" }
conteúdo do documento*	Base64	Conteúdo do documento Word codificado em Base64Este documento inclui cabeçalhos e rodapés. Deve ser um documento Word válido (formatos .docx ou .doc).	base64EncodedDocumentContent

Parâmetros opcionais (Cabeçalho/Rodapé) HTML)

Parâmetro	Tipo	Descrição	Exemplo
Conteúdo do cabeçalho	String	Conteúdo de cabeçalho simples (usado com footerContent quando o formato de controle isHtml/isHtmlMode estiver ativado)	"Company Name"
Conteúdo do rodapé	String	Conteúdo simples do rodapé	"Page PAGE of NUMPAGES"
éHtml	Boolean	Se o conteúdo do cabeçalho/rodapé é HTML	true
isHtmlMode	Boolean	Usar HTML modo para processamento de conteúdo	true
Cabeçalho de todas as páginasHtml	String	Cabeçalho HTML Para todas as páginas. Suporta PAGE, NUMPAGES, SECTION, SECTIONPAGES	"<div style='text-align: center;'>Company Name</div>"
cabeçalhoDaPrimeiraPáginaHtml	String	Cabeçalho HTML apenas para a primeira página	"<div style='text-align: center;'>Title Page</div>"
evenPagesHeaderHtml	String	Cabeçalho HTML para páginas pares	"<div style='text-align: right;'>Book Title</div>"
CabeçalhoHtml de PáginasIrregulares	String	Cabeçalho HTML para páginas ímpares	"<div style='text-align: left;'>Chapter Title</div>"
rodapéhtml de todas as páginas	String	Rodapé HTML para todas as páginas	"Page PAGE of NUMPAGES"
rodapéPrimeiraPáginaHtml	String	Rodapé HTML apenas para a primeira página	"<div style='text-align: center;'>Confidential</div>"
evenPagesRooterHtml	String	Rodapé HTML para páginas pares	"<div style='text-align: center;'>Page PAGE</div>"
Rodapé de páginas ímparesHtml	String	Rodapé HTML para páginas ímpares	"<div style='text-align: center;'>Page PAGE</div>"

Parâmetros opcionais (cabeçalho/rodapé digitado)

Parâmetro	Tipo	Descrição	Exemplo
Cabeçalho de todas as páginas	Object	Conteúdo do cabeçalho digitado para todas as páginas (HeaderFooterContentInUpdate)	-
cabeçalho da primeira página	Object	Cabeçalho digitado para a primeira página	-
Cabeçalho de páginas pares / Cabeçalho de Páginas ímpares	Object	Cabeçalho digitado para páginas pares/ímpares	-
rodapé de todas as páginas / rodapé_primeira_página / rodapéDePáginasPares / Rodapé de páginas ímpares	Object	Conteúdo do rodapé digitado por tipo de página	-

Parâmetros opcionais (geral)

Parâmetro	Tipo	Descrição	Exemplo
nome_da_cultura	String	Código de cultura para processamento de documentos (ex.: "en-US", "fr-FR", "de-DE"). Padrão: nulo. Afeta o idioma e a formatação do documento.	en-US

HTML Suporte de conteúdo

O API apoia HTML Conteúdo em todos os parâmetros de cabeçalho e rodapé:

• HTML Etiquetas: Padrão HTML tags (div, span, p, b, i, u, etc.)
• Estilização CSSEstilos CSS embutidos para formatação
• Texto simplesTexto simples recebe automaticamente formatação profissional padrão.
• Conteúdo Misto: Combinar HTML e texto simples, conforme necessário

Estilo padrão para texto sem formatação:

• CabeçalhosAlinhamento à esquerda, borda inferior, fonte de 10px
• RodapésAlinhamento centralizado, borda superior, fonte de 9px

Opções de layout da página

O API Suporta diferentes layouts de página para cabeçalhos e rodapés:

Tipo de layout	Descrição	Parâmetros obrigatórios
Todas as páginas	Cabeçalho e rodapé iguais em todas as páginas.	allPagesHeaderHtml, allPagesFooterHtml (ou digitado) allPagesHeader, allPagesFooter)
Primeira página	Cabeçalho/rodapé diferente na primeira página	firstPageHeaderHtml, firstPageFooterHtml (ou equivalentes digitados)
Páginas pares/ímpares	Cabeçalhos/rodapés diferentes para páginas pares e ímpares.	evenPagesHeaderHtml, oddPagesHeaderHtml, evenPagesFooterHtml, oddPagesFooterHtml (ou equivalentes digitados)

Saída

O PDF4me Atualizar cabeçalhos e rodapés REST API retorna um JSON resposta. No sucesso do API retorna o documento Word como um Base64string codificada no document campo (ApiV2WordApiCallRes), não como dados binários.

Success Response

Resposta bem-sucedida

Código de status: 200 OK

Tipo de conteúdo: application/json

Corpo da resposta:

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

Campos de resposta:

• documento (string): O documento do Word com cabeçalhos e rodapés atualizados, codificado como Base64
• nome_do_arquivo (string): O nome do arquivo Word de saída
• sucesso (boolean): Se a operação foi bem-sucedida
• mensagem de erro (string): Mensagem de erro se sucesso for falso; caso contrário, nulo

Como usar:

1. Verificar success; se verdadeiro, extraia o document campo do JSON resposta
2. Decifre o Base64 string para obter os dados binários do documento Word
3. Salve ou processe o arquivo do Word usando fileName

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

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 (documento, conteúdo do documento)
• Inválido Base64 codificação em conteúdo do documento
• Documento do Word inválido ou corrompido
• Inválido HTML conteúdo fornecido
• Nome de cultura inválido fornecido
• Campo de número de página não suportado (use PAGE, NUMPAGES, SECTION, SECTIONPAGES)

401 Unauthorized

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

500 Internal Server Error

• Erro de processamento no servidor
• falha no processamento do documento Word
• Erro ao atualizar cabeçalhos e rodapés
• Erro ao carregar o documento a partir de bytes
• Erro ao converter o documento em bytes

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 com Base64-O conteúdo do documento Word é codificado, nunca os dados binários do Word diretamente.

Estrutura de Resposta (ApiV2WordApiCallRes):

{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word file name
"success": true,
"errorMessage": null
}

Cabeçalho Content-Type:

• Sucesso: application/json
• O documento do Word 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

Processando a resposta:

JavaScript/Node.js:

const response = await fetch(url, options);
const data = await response.json();

const base64 = data.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js

Python:

import base64
response_data = response.json()
word_bytes = base64.b64decode(response_data['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)

C#:

var response = JsonConvert.DeserializeObject<UpdateHeadersFootersResponse>(jsonResponse);
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, wordBytes);

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 (cabeçalho e rodapé de todas as 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"
}

Exemplo avançado (primeira página + páginas pares/ímpares):

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

Exemplo de conteúdo 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"
}

Exemplo de texto simples (conteúdo do cabeçalho/conteúdo do rodapé):

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

Exemplos de código

O PDF4me Atualizar cabeçalhos e rodapés 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) Amostra

Completo C# Implementação para atualização de cabeçalhos e rodapés em documentos do Word:

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

• Cabeçalhos de contratoAdicionar avisos de confidencialidade e isenções de responsabilidade legais.
• Documentos judiciaisInclua os números dos processos e as informações de arquivamento.
• Resumos JurídicosAdicione informações sobre o advogado e detalhes do caso.
• Relatórios de ConformidadeIncluir informações regulamentares e datas.

Business & Enterprise

Casos de uso para empresas e negócios

• Identidade Visual de DocumentosAdicionar logotipos e cabeçalhos da empresa a documentos comerciais
• Cabeçalhos de relatórioAdicionar cabeçalhos e rodapés consistentes aos relatórios gerados
• PropostasIncluir informações da empresa e numeração de páginas.
• Comunicação CorporativaAplicar cabeçalhos e rodapés consistentes em todos os documentos.

Education & Research

Casos de uso em educação e pesquisa

• Artigos acadêmicosAdicione informações sobre a instituição e detalhes do curso.
• Relatórios de pesquisaIncluir informações sobre financiamento e agradecimentos.
• Documentos médicos e de pesquisaAdicionar informações sobre o estudo, aprovação ética e detalhes do protocolo.
• Documentos AdministrativosInclua o departamento e as informações de contato.

Finance & Banking

Casos de uso em finanças e bancos

• Relatórios financeirosAdicione informações da empresa e datas do relatório.
• Documentos de auditoriaIncluir informações do auditor e números de relatório
• Arquivos regulatóriosAdicionar informações sobre conformidade regulamentar
• Documentos de investimentoIncluir isenções de responsabilidade e avisos legais.

Obtenha ajuda

Get Your API KeyAPI SamplesGetting Started