Aggiungere HTML Intestazione Piè di pagina a PDF - Branding API
PDF4me Aggiungere HTML Intestazione Piè di pagina a PDF ti consente di aggiungere HTML contenuto come intestazioni, piè di pagina o entrambi PDF documenti. Questo API processi di servizio PDF file e aggiunge HTML contenuti con posizionamento preciso, margini personalizzati e opzioni di targeting della pagina per il branding e l'organizzazione del documento. API riceve PDF contenuto e HTML dati attraverso REST API chiamate, utilizzando Base64 codifica per la sicurezza PDF trasmissione. Con supporto per HTML Contenuti, posizionamento flessibile, margini personalizzati, targeting della pagina ed esclusione della prima pagina, questa soluzione è ideale per il branding dei documenti, la generazione di report e le applicazioni aziendali. PDF flussi di lavoro.
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.
Caratteristiche principali
- HTML Supporto ai contenuti: Aggiungi ricco HTML Contenuti come intestazioni e piè di pagina con supporto completo per la formattazione.
- Posizionamento flessibile: Controllo preciso del posizionamento di intestazione e piè di pagina con margine
- Stile personalizzato: Pieno HTML E CSS supporto per un aspetto professionale
- Targeting della pagina: Applicare intestazioni e piè di pagina a pagine specifiche o a interi documenti
- Salta la prima paginaOpzione per escludere intestazioni e piè di pagina dalla prima pagina
- Risultati professionali: Creare intestazioni e piè di pagina che migliorino l'organizzazione del documento e l'immagine coordinata
- senza veli API Integrazione: REST API progettato per l'automazione PDF flussi di lavoro di modifica e integrazione con i sistemi aziendali
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di aggiunta di intestazione e piè di pagina vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
/api/v2/AddHtmlHeaderFooter
Caratteristiche di intestazione e piè di pagina
HTML Supporto ai contenuti
- HTML Contenuto: Supporto per HTML contenuto con inline CSS stile
- Stile personalizzato: Utilizzare in linea CSS per caratteri, colori, allineamento e stile di base
- Testo e immagini: Supporto per HTML contenuto testuale e immagini incorporate
- Pianura HTML Corda: HTML il contenuto deve essere fornito come stringa semplice (non Base64 codificato)
Posizionamento e disposizione
- Controllo dei marginiPosizionamento preciso tramite misurazioni basate sui pixel (margine sinistro, margine destro, margine superiore, margine inferiore)
- Targeting della pagina: Applicare a pagine specifiche utilizzando le opzioni di pagina (stringa vuota per tutte le pagine, "1", "1,3,5", "2-5", "1,3,7-10", "2-")
- Salta la prima paginaOpzione per escludere intestazioni e piè di pagina dalla prima pagina
- Opzioni di localizzazioneAggiungi contenuto come intestazione, piè di pagina o entrambi
Funzionalità avanzate
- Elaborazione asincronaSupporto per l'elaborazione asincrona con polling per operazioni di lunga durata
- Aspetto professionale: Formattazione e stile coerenti in tutti i documenti
- Posizionamento flessibile: Controlla il posizionamento dell'intestazione e del piè di pagina con misurazioni precise in pixel
REST API Parametri
Elenco completo dei parametri per l'aggiunta HTML Intestazione Piè di pagina a PDF REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori e devono essere forniti per il API per funzionare correttamente.
Parametri richiesti
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| docName* | String | Produzione PDF nome del file con estensione .pdf | output.pdf |
| docContent* | Base64 | Il contenuto dell'input PDF file codificato in Base64 | JVBERi... |
| htmlContenuto* | String | HTML contenuto (semplice) HTML stringa (NON codificata in base64) da aggiungere come intestazione o piè di pagina | <div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div> |
| posizione* | String | Posizione per HTML contenuto: Intestazione, Piè di pagina, O Entrambi | Header |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| pagine | String | Opzioni pagina: stringa vuota per tutte le pagine, "1" per la pagina 1, "1,3,5" per pagine specifiche, "2-5" per l'intervallo di pagine, "1,3,7-10" per misto, "2-" per le pagine da 2 alla fine | "" O "1-3" |
| saltaPrimaPagina | Boolean | Salta la prima pagina (vero) o includi la prima pagina (falso) | false |
| margine sinistro | Raddoppiare | Margine sinistro in pixel | 20.0 |
| margine destro | Raddoppiare | Margine destro in pixel | 20.0 |
| margine superiore | Raddoppiare | Margine superiore in pixel | 50.0 |
| margineInferiore | Raddoppiare | Margine inferiore in pixel | 50.0 |
| asincrono | Boolean | Abilita l'elaborazione asincrona. Quando true, IL API restituisce uno stato 202 e fornisce un polling URL nel Location intestazione | true |
Nota importante: IL
htmlContentil parametro deve essere un pianura HTML corda, non Base64 codificato. Puoi includere inline CSS stile all'interno del HTML.
Produzione
IL PDF4me Aggiungere HTML Intestazione Piè di pagina PDF REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il PDF come Base64-stringa codificata in JSON formato, non come dati binari.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Elaborazione sincrona (impostazione predefinita)
Quando async non è impostato o impostato su false, IL API elabora la richiesta immediatamente:
Codice di stato: 200 OK
Content-Type: application/json
Corpo della risposta:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Campi di risposta:
- docName (stringa): L'output PDF nome del file
- docContent (stringa): La PDF file con HTML intestazione/piè di pagina applicati, codificati come Base64 corda
Come si usa:
- Estrarre il
docContentcampo dal JSON risposta - decodificare il Base64 stringa per ottenere il binario PDF dati
- Salva o elabora il PDF file secondo necessità
Esempio (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Elaborazione asincrona
Quando async: true è impostato, il API elabora la richiesta in modo asincrono:
Codice di stato: 202 Accepted
Intestazioni di risposta:
Location: https://api.pdf4me.com/api/v2/AddHtmlHeaderFooter/poll/12345-abcde-67890
Procedura di votazione:
- Estrarre il
Locationintestazione dalla risposta 202 - Sondare il URL utilizzando GET richieste
- Continua a fare sondaggi finché non ricevi un 200 OK stati
- La risposta finale contiene lo stesso JSON formato con
docNameEdocContentBase64)
Esempio di sondaggio:
// 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
}
Risposte di errore
IL API resi standard HTTP Codici di errore con dettagli dell'errore:
- Parametri di richiesta non validi
- Campi obbligatori mancanti (
docName,docContent,htmlContenuto,posizione) - Non valido Base64 codifica in
docContent - Valore di posizione non valido (deve essere: Intestazione, Piè di pagina o Entrambi)
- Non valido HTML contenuto
- Non valido o mancante API chiave
- API chiave non corretta Base64 codificato in Authorization intestazione
- Mancante
Autorizzazione: Baseintestazione
- Errore di elaborazione lato server
- PDF errore di elaborazione
- HTML errore di rendering
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSONmai binario PDF dati direttamente.
Struttura della risposta:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type Intestazione:
- Successo:
application/json - IL PDF è incorporato come un Base64 stringa all'interno della JSON risposta
Perché Base64?
- JSON- codifica sicura per dati binari
- Facile da trasmettere HTTP
- Compatibile con tutti i linguaggi di programmazione
- Può essere incorporato direttamente in JSON senza sfuggire ai problemi
Codifica Base64 A 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);
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 utilizzareAuthorization: Basic YWJjMTIz
Carico utile
Esempio di base (solo campi obbligatori):
{
"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"
}
Esempio avanzato (con tutti i campi opzionali):
{
"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: IL
htmlContentil campo deve contenere pianura HTML come una corda, non Base64 codificato. Puoi usare inline CSS stile all'interno del HTML tag.
Esempi di codice
IL PDF4me Aggiungere HTML Intestazione Piè di pagina a PDF REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# Esempio (CSharp)
Completo C# implementazione per aggiungere intestazioni e piè di pagina a PDF:
Java Campione
Java implementazione con gestione completa degli errori ed elaborazione delle risposte:
JavaScript Campione
Node.js e compatibile con i browser JavaScript implementazione:
Google Script Campione
Google Apps Script implementazione per Google Workspace integrazione:
Casi d'uso e applicazioni industriali
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casi d'uso per servizi legali e professionali
- Documentazione legaleApplicare clausole di esclusione di responsabilità e avvisi di riservatezza ai documenti legali
- Intestazioni del contrattoAggiungere intestazioni e piè di pagina a contratti e accordi
- Documentazione di conformità: Includere le note di conformità nelle intestazioni e nei piè di pagina
- Documentazione per il clienteAggiungi intestazioni e piè di pagina professionali ai documenti dei clienti.
Casi d'uso aziendali e per le imprese
- Branding del documentoAggiungi loghi aziendali, intestazioni e piè di pagina ai documenti PDF
- Generazione di reportAggiungere intestazioni e piè di pagina coerenti ai report generati
- Documenti aziendaliMigliora l'aspetto professionale del tuo sito con intestazioni e piè di pagina personalizzati con il tuo marchio.
- Branding aziendale: Applicare intestazioni e piè di pagina coerenti a tutti i documenti aziendali
Casi d'uso in ambito educativo e di ricerca.
- Articoli accademiciAggiungere numeri di pagina, intestazioni e piè di pagina alle pubblicazioni accademiche
- Documenti di ricercaFormattare i documenti di ricerca con intestazioni e piè di pagina appropriati.
- Formattazione della tesiAggiungere intestazioni e piè di pagina a tesi e dissertazioni
- Materiali didatticiArricchisci i documenti didattici con intestazioni e piè di pagina
Casi d'uso in ambito finanziario e bancario
- Rapporti finanziariAggiungere intestazioni e piè di pagina a report e bilanci finanziari.
- Formattazione della fattura: Applicare intestazioni e piè di pagina a fatture e documenti finanziari
- Documentazione di conformità: Includere le informazioni sulla conformità nelle intestazioni e nei piè di pagina
- Rapporti di auditAggiungi intestazioni e piè di pagina professionali ai report di audit