Adicionar cabeçalho e rodapé com imagem - Excel API
PDF4me Adicionar Cabeçalho e Rodapé com Imagem Permite adicionar cabeçalhos e rodapés de imagem personalizáveis a Excel Documentos com controle abrangente de posicionamento e formatação. Isto API processos de serviço Excel O editor permite criar arquivos e adicionar cabeçalhos ou rodapés de imagem com controle de posicionamento (cabeçalho/rodapé), alinhamento horizontal (esquerda, centro, direita), direcionamento para planilhas (planilhas específicas ou todas as planilhas) e margens de página em centímetros. API recebe Excel conteúdo do documento e dados de imagem através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para PNG, JPG, JPEGCompatível com formatos de imagem como .jpg e GIF, esta solução é ideal para identidade visual corporativa, relatórios profissionais e fluxos de trabalho de automação de documentos.
Autenticando seu API Solicitar
Inclua o seu API digite a chave na solicitação para autenticar com o PDF4me REST API.
Principais características
- Posicionamento do cabeçalho ou rodapéEscolha se deseja inserir imagens no cabeçalho ou no rodapé do documento.
- Controle de posiçãoAlinhar imagens à esquerda, ao centro ou à direita na área do cabeçalho/rodapé
- Planilha de ObjetivosAplicar imagens a planilhas específicas por nome ou índice, ou a todas as planilhas.
- Personalização de margemConfigure as margens superior, inferior, esquerda e direita da página em centímetros.
- Suporte a formatos de imagem: PNG, JPG, JPEGe formatos GIF
REST API Ponto final
O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de cabeçalho/rodapé de imagem para Excel são realizadas por meio de um único ponto final:
- Método: POST
- Ponto final:
office/ApiV2Excel/ExcelAddImageHeaderFooter
REST API Parâmetros
Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios. Todas as solicitações usam documento, conteúdo do documento, conteúdo da imagem (nível raiz), e ação adicionarCabeçalhoRodapéDaImagemÀExcelOutras opções são propriedades do objeto de ação.
Parâmetros obrigatórios (nível raiz)
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| documento* | Object | Referência do documento. Deve conter Nome (corda): Excel Nome do arquivo com extensão .xlsx ou .xls | { "Name": "data.xlsx" } |
| conteúdo do documento* | String (Base64) | Excel conteúdo do documento codificado em Base64 | UEsDBBQABgAIAAAA... |
| conteúdo da imagem* | String (Base64) | Conteúdo do arquivo de imagem codificado em Base64Suporta PNG, JPG, JPEG, formatos GIF | iVBORw0KGgoAAAANS... |
| ação adicionarCabeçalhoRodapéDaImagemÀExcel* | Object | Configuração da ação (posição, direcionamento da planilha, margens, etc.) | Veja o exemplo de carga útil abaixo. |
Parâmetros opcionais (dentro de addImageHeaderFooterToExcelAction)
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| éCabeçalho | Boolean | Seleção de alocação. true = Adicionar imagem ao cabeçalho do documento (padrão), false = Adicionar imagem ao rodapé do documento | true |
| posição | String | Alinhamento horizontal no cabeçalho/rodapé. Esquerda, Centro, ou CertoPadrão: "Centralizado". Sem distinção entre maiúsculas e minúsculas. | Center |
| Nomes das planilhas | Array (corda[]) | Matriz de nomes de planilhas às quais a imagem será aplicada. Se `worksheetNames` e `worksheetIndexes` estiverem vazios, a imagem será aplicada a todas as planilhas. | ["Sheet1", "Report"] |
| Índices da planilha | Array (int[]) | Matriz de índices de planilhas (baseada em 1). Se `worksheetNames` e `worksheetIndexes` estiverem vazios, aplica-se a todas as planilhas. | [1, 2] |
| margem superior | Número (duplo) | Margem superior da página em centímetros. Padrão: 1,9 | 1.9 |
| margem inferior | Número (duplo) | Margem inferior da página em centímetros. Padrão: 1,9 | 1.9 |
| margem esquerda | Número (duplo) | Margem esquerda da página em centímetros. Padrão: 1,9 | 1.9 |
| margem direita | Número (duplo) | Margem direita da página em centímetros. Padrão: 1,9 | 1.9 |
| nome_da_cultura | String | Código de cultura para processamento de documentos (por exemplo, "en-US", "de-DE", "fr-FR") | en-US |
Observação: Se ambos Nomes das planilhas e Índices da planilha Se estiverem vazias ou nulas, a imagem será aplicada a todas as planilhas do Excel arquivo.
Saída
O PDF4me Adicionar Cabeçalho e Rodapé com Imagem REST API retorna o Excel documento como um Base64string codificada em JSON formato, não como dados binários.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Processamento síncrono (padrão)
O API processa a solicitação e retorna:
Código de status: 200 OK
Content-Type: application/json
Corpo da resposta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
Campos de resposta:
- documento (string): O Excel Documento com cabeçalho/rodapé de imagem aplicado, codificado como Base64 corda
- nome_do_arquivo (string): A saída Excel nome do arquivo
- sucesso (booleano): Indica se a solicitação foi bem-sucedida.
- mensagem de erro (string ou nulo): Detalhes do erro quando o sucesso for falso
Como usar:
- Extraia o
documentcampo do JSON resposta (Base64) - Decifre o Base64 string para obter o binário Excel dados do documento
- Salvar ou processar o Excel arquive conforme necessário
Exemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const excelBytes = atob(data.document); // Decode Base64
// Save or process excelBytes
Processamento assíncrono
Comportamento assíncrono (202 Accepted (com polling) é controlado pela configuração do servidor, não por um parâmetro no corpo da requisição. Quando habilitado, o API pode retornar um status 202 com uma pesquisa URL no Location cabeçalho. Consulte o URL com GET Faça solicitações até receber 200. OK com o mesmo formato de resposta (documento, nome do arquivo, sucesso, mensagem de erro).
Respostas de erro
O API retorna padrão HTTP Códigos de erro com detalhes do erro:
- Parâmetros de solicitação inválidos
- Campos obrigatórios ausentes (
documentocomNome,conteúdo do documento,conteúdo da imagem,ação adicionarCabeçalhoRodapéDaImagemÀExcel) - Inválido Base64 codificação em
conteúdo do documentoouconteúdo da imagem - Inválido ou corrompido Excel documento
- Arquivo de imagem inválido ou corrompido
- Seleção de planilha inválida (os nomes ou índices não existem ou estão fora do intervalo).
- Inválido ou ausente API chave
- API chave não está corretamente Base64 codificado em Authorization cabeçalho
- Ausente
Autorização: Básicacabeçalho
- Erro de processamento no servidor
- Excel falha no processamento do documento
- Falha na adição de cabeçalho/rodapé de imagem
Formato da resposta de erro:
{
"error": "Error message describing what went wrong"
}
Detalhes do formato da resposta
Importante: O API sempre retorna JSON, nunca binário Excel dados diretamente.
Estrutura da resposta:
{
"document": "string", // Base64-encoded Excel document content
"fileName": "string", // Output Excel filename
"success": true,
"errorMessage": "string or null"
}
Decodificando Base64 para Excel Documento:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
excel_bytes = base64.b64decode(response['document'])
with open('output.xlsx', 'wb') as f:
f.write(excel_bytes)
C#:
byte[] excelBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.xlsx", excelBytes);
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 usarAuthorization: Basic YWJjMTIz
Carga útil
Exemplo básico (somente campos obrigatórios):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {}
}
Exemplo avançado (com todos os campos opcionais):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {
"isHeader": true,
"position": "Center",
"worksheetNames": ["Sheet1", "Report"],
"worksheetIndexes": [1, 2],
"topMargin": 1.9,
"bottomMargin": 1.9,
"leftMargin": 1.9,
"rightMargin": 1.9,
"cultureName": "en-US"
}
}
Exemplos de código
O PDF4me Adicionar cabeçalho e rodapé de imagem Excel 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#
- Java
- JavaScript
- Python
C# (CSharp) Exemplo
Completo C# Implementação para adicionar cabeçalhos/rodapés de imagem a Excel documentos:
Java Amostra
Java Implementação com tratamento completo de erros e processamento de respostas:
JavaScript Amostra
Node.js e compatível com navegadores JavaScript Implementação:
Casos de uso e aplicações industriais
- Finance & Accounting
- Sales & Marketing
- Human Resources
- Operations & Manufacturing
- Healthcare & Medical
- Legal & Professional Services
Casos de uso em finanças e contabilidade
- Demonstrações FinanceirasAdicionar cabeçalhos com o logotipo da empresa aos relatórios trimestrais
- Relatórios orçamentáriosInserir logotipos dos departamentos nas planilhas de orçamento.
- Documentos de auditoriaAplicar marcas d'água com o logotipo da empresa de auditoria nos rodapés.
- Relatórios de despesasAdicionar cabeçalhos com o logotipo da empresa para os relatórios de despesas.
Casos de uso em vendas e marketing
- Relatórios de VendasInserir logotipos da marca da empresa nos relatórios de vendas semanais.
- Planilhas de PreçosAdicionar cabeçalhos com logotipos aos documentos de preços para clientes.
- Relatórios de marketingAplicar logotipos de campanha aos relatórios analíticos
- Apresentações para clientesAdicionar logotipos de co-branding do cliente aos entregáveis.
Casos de uso de recursos humanos
- Relatórios de folha de pagamentoInserir cabeçalhos com o logotipo da empresa nos documentos de pagamento.
- Registros de funcionáriosAdicionar o logotipo do departamento de RH aos modelos de pessoal
- Inscrição em BenefíciosAplicar os logotipos dos fornecedores de benefícios às fichas de inscrição.
- Avaliações de desempenhoAdicione a identidade visual da sua empresa aos modelos de avaliação.
Casos de uso em operações e manufatura
- Relatórios de inventárioInserir logotipos de localização do armazém nas folhas de inventário.
- Relatórios de ProduçãoAdicionar logotipos das unidades de produção aos relatórios de fabricação
- Relatórios de QualidadeAplicar logotipos de certificação de qualidade nos cabeçalhos.
- Relatórios da cadeia de suprimentosAdicionar logotipos de fornecedores aos documentos de compras
Casos de uso na área da saúde e medicina
- Relatórios de pacientesAdicionar cabeçalhos com o logotipo do hospital ou clínica aos dados do paciente
- Resultados de laboratórioInserir a logomarca do laboratório nas folhas de resultados dos testes.
- Reclamações de segurosAplicar os logotipos das seguradoras aos documentos de sinistro.
- Registros médicosAdicionar a identidade visual da unidade de saúde às fichas informativas sobre saúde.
Casos de uso de serviços jurídicos e profissionais
- Relatórios de clientesInserir cabeçalhos com o logotipo do escritório de advocacia nos documentos entregues aos clientes.
- Documentos do casoAdicionar logotipos de áreas de atuação aos arquivos de processos judiciais
- Modelos de ContratoAplicar a identidade visual da empresa às planilhas de contratos.
- Extratos de cobrançaInserir o logotipo da empresa nos relatórios de faturamento jurídico