Passa al contenuto principale
PDF4me APIIntegrazioniBase di conoscenzaEstensioniTester APIBlog

Aggiorna intestazioni e piè di pagina - Gestione intestazioni API

PDF4me Aggiorna intestazioni e piè di pagina consente di aggiungere o modificare intestazioni e piè di pagina nei documenti Word con funzionalità complete HTML supporto ai contenuti e opzioni di stile professionali. Questo API il servizio elabora i file Word e applica intestazioni e piè di pagina a diversi layout di pagina, tra cui la prima pagina, le pagine pari/dispari e tutte le pagine con l'applicazione automatica di uno stile predefinito professionale, HTML elaborazione dei contenuti e formattazione flessibile specifica per pagina. API riceve il contenuto del documento Word tramite REST API chiamate, utilizzando Base64 codifica per trasmissione sicura. Con supporto per i campi del numero di pagina (PAGE, NUMPAGES, SECTION, SECTIONPAGES), HTML Grazie alla formattazione e allo stile professionale automatico, questa soluzione è ideale per la personalizzazione dei documenti con il marchio aziendale, la numerazione delle pagine e i flussi di lavoro di presentazione professionale.

Articoli correlati del blog
Non ci sono ancora post sul blog dedicati a questa funzionalità — in arrivo a breve.
Nel frattempo, dai un'occhiata al blog di PDF4me per trovare tutorial e procedure operative su tutte le piattaforme.
Visita il blog →

Autenticazione del tuo API Richiesta​

Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.

Get your api Key

Caratteristiche principali​

  • Diversi tipi di paginaSupporto per tutte le pagine, prima pagina, pagine pari/dispari
  • HTML Supporto ai contenuti: Ricco HTML contenuti con stile professionale
  • Stile automaticoStile predefinito professionale per contenuti di testo semplice
  • Campi del numero di pagina: Supporto per PAGE, NUMPAGES, SECTION, SECTIONPAGES
  • Layout flessibile: Intestazioni/piè di pagina diversi per diversi tipi di pagina
  • Supporto culturaleElaborazione dei documenti specifici per la località
  • Conservazione del formato: Mantiene la struttura originale del documento
  • Aspetto professionaleApplicazione automatica dello styling professionale

REST API Punto finale​

IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di aggiornamento dell'intestazione e del piè di pagina vengono eseguite tramite un unico endpoint:

  • Metodo: POST
  • Punto finale: office/ApiV2Word/UpdateHeadersAndFooters

REST API Parametri​

Elenco completo dei parametri per l'aggiornamento di intestazioni e piè di pagina REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.

Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori. I parametri avanzati consentono un controllo preciso su intestazioni e piè di pagina specifici per ciascuna pagina.

Parametri richiesti​

ParametroTipoDescrizioneEsempio
documento*ObjectDescrizione del documento. Deve includere Nome string): output Nome del file Word con estensione .docx{ "Name": "document.docx" }
docContent*Base64Il contenuto del documento Word codificato in Base64A questo documento vengono aggiunti intestazioni e piè di pagina. Deve essere un documento Word valido (formati .docx, .doc).base64EncodedDocumentContent

Parametri opzionali (intestazione/piè di pagina) HTML)​

ParametroTipoDescrizioneEsempio
contenuto dell'intestazioneStringContenuto di intestazione semplice (utilizzato con footerContent quando il formato di controllo è isHtml/isHtmlMode)"Company Name"
piè di paginaContenutoStringContenuto semplice del piè di pagina"Page PAGE of NUMPAGES"
isHtmlBooleanSe il contenuto dell'intestazione/piè di pagina è HTMLtrue
isHtmlModeBooleanUtilizzo HTML modalità di elaborazione dei contenutitrue
allPagesHeaderHtmlStringIntestazione HTML per tutte le pagine. Supporta PAGE, NUMPAGES, SECTION, SECTIONPAGES"<div style='text-align: center;'>Company Name</div>"
firstPageHeaderHtmlStringIntestazione HTML solo per la prima pagina"<div style='text-align: center;'>Title Page</div>"
evenPagesHeaderHtmlStringIntestazione HTML per le pagine pari"<div style='text-align: right;'>Book Title</div>"
oddPagesHeaderHtmlStringIntestazione HTML per le pagine dispari"<div style='text-align: left;'>Chapter Title</div>"
allPagesFooterHtmlStringPiè di pagina HTML per tutte le pagine"Page PAGE of NUMPAGES"
firstPageFooterHtmlStringPiè di pagina HTML solo per la prima pagina"<div style='text-align: center;'>Confidential</div>"
evenPagesFooterHtmlStringPiè di pagina HTML per pagine pari"<div style='text-align: center;'>Page PAGE</div>"
oddPagesFooterHtmlStringPiè di pagina HTML per pagine dispari"<div style='text-align: center;'>Page PAGE</div>"

Parametri opzionali (intestazione/piè di pagina digitati)​

ParametroTipoDescrizioneEsempio
Intestazione di tutte le pagineObjectContenuto dell'intestazione digitato per tutte le pagine (HeaderFooterContentInUpdate)-
Intestazione della prima paginaObjectIntestazione stampata per la prima pagina-
evenPagesHeader / oddPagesHeaderObjectIntestazione tipografica per pagine pari/dispari-
piè di pagina di tutte le pagine / piè di pagina / evenPagesFooter / dispariPiè di paginaObjectContenuto del piè di pagina digitato per tipo di pagina-

Parametri opzionali (generali)​

ParametroTipoDescrizioneEsempio
Nome della culturaStringCodice cultura per l'elaborazione dei documenti (ad esempio, "en-US", "fr-FR", "de-DE"). Valore predefinito: null. Influisce sulla lingua e sulla formattazione del documento.en-US

HTML Supporto ai contenuti​

IL API supporta HTML contenuto in tutti i parametri di intestazione e piè di pagina:

  • HTML Etichette: Standard HTML tag (div, span, p, b, i, u, ecc.)
  • Stile CSS: Stili CSS inline per la formattazione
  • Testo semplice: Il testo semplice riceve automaticamente la formattazione professionale predefinita
  • Contenuti misti: Combinare HTML e testo semplice secondo necessità

Stile predefinito per il testo semplice:

  • Intestazioni: Allineamento a sinistra, bordo inferiore, carattere da 10px
  • Piè di paginaAllineamento centrato, bordo superiore, carattere da 9px

Opzioni di layout della pagina​

IL API supporta diversi layout di pagina per intestazioni e piè di pagina:

Tipo di layoutDescrizioneParametri richiesti
Tutte le pagineStessa intestazione/piè di pagina su tutte le pagineallPagesHeaderHtml, allPagesFooterHtml (o digitato) allPagesHeader, allPagesFooter)
Prima paginaIntestazione/piè di pagina diverso nella prima paginafirstPageHeaderHtml, firstPageFooterHtml (o equivalenti dattiloscritti)
Pagine pari/dispariIntestazioni/piè di pagina diversi per le pagine pari e dispari.evenPagesHeaderHtml, oddPagesHeaderHtml, evenPagesFooterHtml, oddPagesFooterHtml (o equivalenti dattiloscritti)

Produzione​

IL PDF4me Aggiorna intestazioni e piè di pagina REST API restituisce un JSON risposta. In caso di successo la API restituisce il documento Word come un Base64stringa codificata nel document campo (ApiV2WordApiCallRes), non come dati binari.

Risposta di successo

Codice di stato: 200 OK

Tipo di contenuto: application/json

Corpo della risposta:

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

Campi di risposta:

  • documento string): Il documento Word con intestazioni e piè di pagina aggiornati, codificato come Base64
  • Nome file string): Il nome del file Word di output
  • successo boolean): Se l'operazione è riuscita
  • messaggio di errore string): Messaggio di errore se il successo è falso; altrimenti nullo

Come si usa:

  1. Controllo success; se vero, estrai il document campo dal JSON risposta
  2. decodificare il Base64 stringa per ottenere i dati binari del documento Word
  3. Salva o elabora il file Word utilizzando fileName

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

Esempio di richiesta​

Intestazione​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
  • IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
  • Esempio: se il tuo API la chiave è abc123, codificalo in Base64 e utilizzare Authorization: Basic YWJjMTIz

Carico utile​

Esempio base (intestazione e piè di pagina per tutte le pagine):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center;'>Company Name</div>",
 "allPagesFooterHtml": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

Esempio avanzato (prima pagina + pagine pari/dispari):

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

Esempio di contenuto 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"
}

Esempio di testo semplice (headerContent/footerContent):

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

Esempi di codice​

IL PDF4me Aggiorna intestazioni e piè di pagina REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:

C# CSharp) Campione

Completo C# Implementazione per l'aggiornamento di intestazioni e piè di pagina nei documenti Word:

Casi d'uso e applicazioni industriali​

Casi d'uso per servizi legali e professionali

  • Intestazioni del contrattoAggiungere avvisi di riservatezza e note legali.
  • Documenti del tribunale: Includere i numeri di pratica e le informazioni di deposito
  • Note legaliAggiungere le informazioni sull'avvocato e i dettagli del caso.
  • Rapporti di conformità: Includere informazioni e date relative alla normativa

Richiedi assistenza​

Get Your API KeyAPI SamplesGetting Started