Adicionar cabeçalho e rodapé de texto - Excel API
PDF4me Adicionar cabeçalho de texto e rodapé Permite adicionar cabeçalhos e rodapés de texto personalizáveis a Excel Documentos com controle de formatação abrangente. Isto API processos de serviço Excel O editor de texto adiciona arquivos e texto às seções de cabeçalho ou rodapé, com opções de estilo de fonte (família, tamanho, cor), níveis de transparência, ângulos de rotação e orientação (horizontal, vertical, diagonal, invertida). API recebe Excel conteúdo do documento através REST API chamadas, utilizando Base64 Codificação para transmissão segura. Esta solução é ideal para personalização da identidade visual de documentos, números de página, datas e fluxos de trabalho de apresentações profissionais.
Autenticando seu API Solicitar
Inclua o seu API digite a chave na solicitação para autenticar com o PDF4me REST API.
Principais características
- Conteúdo de texto personalizadoAdicione qualquer texto como cabeçalho ou rodapé em Excel documentos
- Personalização de fontesControle a família da fonte, o tamanho, a cor e os nomes específicos da fonte.
- Controle de TransparênciaDefina o texto como semitransparente (50% de opacidade) ou totalmente opaco (100%).
- Rotação e orientaçãoAplicar ângulos de rotação ou orientações predefinidas (horizontal, vertical, diagonal, invertida)
- Apoio à CulturaEspecifique os códigos de cultura para a renderização e formatação adequadas do texto.
REST API Ponto final
- Método: POST
- Ponto final:
office/ApiV2Excel/ExcelAddTextHeaderFooter
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 documentoe um objeto de ação. Os parâmetros específicos da operação são propriedades de ação adicionar cabeçalho de texto e rodapé ao Excel.
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... |
| ação adicionar cabeçalho de texto e rodapé ao Excel* | Object | Configuração de ação. Deve conter pelo menos texto da marca d'água (string): texto a ser exibido como cabeçalho ou rodapé | Veja o exemplo de carga útil abaixo. |
Parâmetros opcionais (dentro de addTextHeaderFooterToExcelAction)
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| família de fontes | String | Nome da família da fonte (por exemplo, Arial, Times New Roman). Padrão: Arial | Arial |
| tamanho da fonte | Número | Tamanho da fonte em pontos (8-72). Padrão: 72 | 12 |
| cor da fonte | String | Código hexadecimal da cor ou nome da cor. Padrão: preto | #0000FF |
| semitransparente | Boolean | verdadeiro = 50% de opacidade, falso = 100% (padrão) | false |
| rotação | Número | Ângulo de rotação em graus (0-360). Padrão: 0 | 45 |
| nome da fonte | String | Nome específico da fonte (substitui fontFamily) | Arial Bold |
| orientação | String | Horizontal, Vertical, Diagonal, ou De cabeça para baixoTem prioridade sobre a rotação. | Horizontal |
| nome_da_cultura | String | Código cultural para renderização de texto (por exemplo, "en-US", "de-DE") | en-US |
Saída
O API retorna o Excel documento como um Base64string codificada em JSON formato.
- Success Response
- Error Responses
Código de status: 200 OK
Corpo da resposta:
{
"document": "UEsDBBQABgAIAAAA...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
400 Bad RequestParâmetros inválidos, campos obrigatórios ausentes, inválido Base64 ou documento. 401 Unauthorized: Inválido ou ausente API chave. 500 Internal Server ErrorErro de processamento no servidor.
Exemplo de solicitação
Cabeçalho
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Carga útil (básica)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024"
}
}
Carga útil (com formatação opcional)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024",
"fontFamily": "Arial",
"fontSize": 12,
"fontColor": "#0000FF",
"orientation": "Horizontal"
}
}
Exemplos de código
- GitHub