Ajouter HTML En-tête et pied de page PDF - Image de marque API

PDF4me Ajouter HTML En-tête et pied de page PDF vous permet d'ajouter HTML contenu sous forme d'en-têtes, de pieds de page ou des deux PDF documents. Ceci API processus de service PDF fichiers et ajouts HTML Contenu avec positionnement précis, marges personnalisées et options de ciblage des pages pour la mise en valeur et l'organisation des documents. API reçoit PDF contenu et HTML données via REST API appels, utilisant Base64 encodage pour la sécurité PDF transmission. Avec prise en charge de HTML Avec son contenu, son positionnement flexible, ses marges personnalisées, le ciblage des pages et l'exclusion de la première page, cette solution est idéale pour la personnalisation des documents, la génération de rapports et les applications d'entreprise. PDF flux de travail.

Articles de blog connexes

Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.

En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.

Consultez le blog →

Authentification de votre API Demande

Pour accéder au PDF4me REST APIChaque requête doit inclure des informations d'authentification valides. L'authentification garantit la sécurité des communications et confirme votre identité en tant qu'utilisateur autorisé. REST API.

Get your api Key

Caractéristiques principales

• HTML Support du contenuAjoutez des riches HTML Contenu sous forme d'en-têtes et de pieds de page avec prise en charge complète du style
• Positionnement flexibleContrôlez le positionnement de l'en-tête et du pied de page grâce à un contrôle précis des marges.
• Style personnalisé: Complet HTML et CSS soutien à l'apparence professionnelle
• Ciblage de page: Appliquer des en-têtes et des pieds de page à des pages spécifiques ou à des documents entiers
• Passer la première pageOption permettant d'exclure les en-têtes et les pieds de page de la première page
• Résultats professionnelsCréez des en-têtes et des pieds de page qui améliorent l'organisation des documents et l'image de marque.
• Sans couture API Intégration: REST API conçu pour l'automatisation PDF flux de travail d'édition et intégration des systèmes d'entreprise

REST API Point de terminaison

Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations d'ajout d'en-tête et de pied de page sont effectuées via un point de terminaison unique :

• Méthode: POST
• Point final : /api/v2/AddHtmlHeaderFooter

Fonctionnalités de l'en-tête et du pied de page

HTML Support du contenu

• HTML Contenu: Soutien à HTML contenu avec intégration CSS style
• Style personnaliséUtilisez l'option « inline » CSS pour les polices, les couleurs, l'alignement et le style de base
• Texte et images: Soutien à HTML contenu textuel et images intégrées
• Plaine HTML Chaîne: HTML Le contenu doit être fourni sous forme de chaîne de caractères simple (et non Base64 encodé)

Positionnement et mise en page

• Contrôle des marges: Positionnement précis grâce à des mesures basées sur les pixels (margeGauche, margeDroite, margeHaut, margeBas)
• Ciblage de pageAppliquer à des pages spécifiques en utilisant les options de page (chaîne vide pour toutes les pages, "1", "1,3,5", "2-5", "1,3,7-10", "2-")
• Passer la première pageOption permettant d'exclure les en-têtes et les pieds de page de la première page
• Options de localisationAjoutez du contenu comme en-tête, pied de page ou les deux.

Fonctionnalités avancées

• Traitement asynchrone: Prise en charge du traitement asynchrone avec interrogation pour les opérations de longue durée
• Apparence professionnelle: Mise en forme et style uniformes dans tous les documents
• Positionnement flexibleContrôlez le positionnement de l'en-tête et du pied de page avec des mesures précises en pixels.

REST API Paramètres

Liste complète des paramètres pour l'ajout HTML En-tête et pied de page PDF REST APILes paramètres sont organisés par catégorie pour une meilleure compréhension et une mise en œuvre plus aisée.

Important: Les paramètres marqués d'un astérisque (*) sont obligatoires et doivent être fournis pour le API pour fonctionner correctement.

Paramètres requis

Paramètre	Taper	Description	Exemple
Nom du document*	String	Sortir PDF Nom de fichier avec l'extension .pdf	output.pdf
docContent*	Base64	Le contenu de l'entrée PDF fichier encodé en Base64	JVBERi...
htmlContenu*	String	HTML contenu (simple) HTML chaîne de caractères (non encodée en base64) à ajouter comme en-tête ou pied de page	<div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div>
emplacement*	String	Emplacement pour HTML contenu: En-tête, Pied de page, ou Les deux	Header

Paramètres optionnels

Paramètre	Taper	Description	Exemple
pages	String	Options de page : chaîne vide pour toutes les pages, "1" pour la page 1, "1,3,5" pour des pages spécifiques, "2-5" pour la plage de pages, "1,3,7-10" pour mixte, "2-" pour les pages de 2 à la fin	"" ou "1-3"
skipFirstPage	Boolean	Ignorer la première page (vrai) ou inclure la première page (faux)	false
marge gauche	Double	Marge gauche en pixels	20.0
marge droite	Double	Marge droite en pixels	20.0
marge supérieure	Double	Marge supérieure en pixels	50.0
marge inférieure	Double	Marge inférieure en pixels	50.0
asynchrone	Boolean	Activer le traitement asynchrone. Lorsque true, le API renvoie un statut 202 et fournit un système d'interrogation URL dans le Location en-tête	true

Remarque importante : Le htmlContent Le paramètre doit être un plaine HTML chaîne, pas Base64 encodé. Vous pouvez inclure en ligne CSS style au sein du HTML.

Sortir

Le PDF4me Ajouter HTML En-tête et pied de page PDF REST API renvoie des réponses différentes selon le mode de traitement. API renvoie le PDF comme un Base64chaîne encodée dans JSON format, et non sous forme de données binaires.

Success Response

Traitement synchrone (par défaut)

Quand async n'est pas défini ou est défini sur false, le API traite la demande immédiatement :

Code d'état : 200 OK

Content-Type: application/json

Corps de la réponse :

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}

Champs de réponse :

• Nom du document (chaîne de caractères) : La sortie PDF nom de fichier
• docContent (chaîne de caractères) : Le PDF fichier avec HTML En-tête/pied de page appliqué, encodé comme Base64 chaîne

Mode d'emploi :

1. Extraire le docContent champ du JSON réponse
2. Décodez le Base64 chaîne permettant d'obtenir le binaire PDF données
3. Enregistrer ou traiter le PDF classer selon les besoins

Exemple (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes

Asynchronous Processing

Traitement asynchrone

Quand async: true est réglé, le API traite la requête de manière asynchrone :

Code d'état : 202 Accepted

En-têtes de réponse :

Location: https://api.pdf4me.com/api/v2/AddHtmlHeaderFooter/poll/12345-abcde-67890

Processus de sondage :

1. Extraire le Location En-tête de la réponse 202
2. Sondage URL en utilisant GET demandes
3. Continuez à sonder jusqu'à ce que vous receviez un 200 OK statut
4. La réponse finale contient la même chose JSON format avec docName et docContent (Base64)

Exemple de sondage :

// 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
}

Error Responses

Réponses d'erreur

Le API retours standard HTTP codes d'erreur avec détails de l'erreur :

400 Bad Request

• Paramètres de requête invalides
• Champs obligatoires manquants (Nom du document, docContent, htmlContenu, emplacement)
• Invalide Base64 encodage dans docContent
• Valeur d'emplacement invalide (doit être : En-tête, Pied de page ou Les deux)
• Invalide HTML contenu

401 Unauthorized

• Invalide ou manquant API clé
• API clé non correctement Base64 encodé dans Authorization en-tête
• Manquant Autorisation : de base en-tête

500 Internal Server Error

• Erreur de traitement côté serveur
• PDF échec du traitement
• HTML échec de rendu

Format de réponse en cas d'erreur :

{
  "error": "Error message describing what went wrong"
}

Response Format Details

Détails du format de réponse

Important: Le API toujours retourne JSON, jamais binaire PDF données directement.

Structure de la réponse :

{
  "docName": "string",      // Output PDF filename
  "docContent": "string"    // Base64-encoded PDF content
}

Content-Type En-tête :

• Succès: application/json
• Le PDF est intégré en tant que Base64 chaîne à l'intérieur de la JSON réponse

Pourquoi Base64?

• JSON-codage sûr pour les données binaires
• Facile à transmettre sur HTTP
• Compatible avec tous les langages de programmation
• Peut être directement intégré dans JSON sans échapper aux problèmes

Décodage Base64 à 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);

Exemple de requête

En-tête

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Note:

• Obtenez votre API clé de la PDF4me Tableau de bord
• Le API La clé doit être Base64 encodé et préfixé par « Basic » dans le Authorization en-tête
• Exemple : Si votre API La clé est abc123, encodez-le en Base64 et utiliser Authorization: Basic YWJjMTIz

Charge utile

Exemple simple (champs obligatoires uniquement) :

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

Exemple avancé (avec tous les champs facultatifs) :

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

Important: Le htmlContent Le champ doit contenir plaine HTML comme une chaîne, pas Base64 encodé. Vous pouvez utiliser en ligne CSS style au sein du HTML étiquettes.

Exemples de code

Le PDF4me Ajouter HTML En-tête et pied de page PDF REST API propose des exemples de code dans plusieurs langages de programmation. Choisissez le langage qui convient le mieux à votre environnement de développement :

C#

C# Exemple (CSharp)

Complet C# implémentation pour ajouter des en-têtes et des pieds de page à PDF:

View C# Sample

Java

Java Échantillon

Java implémentation avec gestion complète des erreurs et traitement des réponses :

View Java Sample

JavaScript

JavaScript Échantillon

Node.js et compatible avec les navigateurs JavaScript mise en œuvre:

View JavaScript Sample

Python

Python Échantillon

Python implémentation avec la bibliothèque requests et JSON manutention:

View Python Sample

Salesforce

Salesforce Échantillon

Salesforce Apex mise en œuvre pour CRM intégration :

View Salesforce Sample

n8n

n8n Échantillon

n8n Mise en œuvre des flux de travail pour l'automatisation :

View n8n Sample

Google Script

Google Script Échantillon

Google Apps Script mise en œuvre pour Google Workspace intégration :

View Google Script Sample

AWS Lambda

AWS Lambda Échantillon

sans serveur AWS Lambda implémentation de la fonction :

View AWS Lambda Sample

Cas d'utilisation et applications industrielles

Legal & Professional Services

Cas d'utilisation des services juridiques et professionnels

• Documentation juridique: Intégrer des mentions légales et des avis de confidentialité dans les documents juridiques
• En-têtes de contratAjouter des en-têtes et des pieds de page aux contrats et accords
• Documentation de conformité: Inclure les mentions légales dans les en-têtes et les pieds de page
• Documentation clientAjouter des en-têtes et des pieds de page professionnels aux documents clients

Business & Enterprise

Cas d'utilisation en entreprise

• Image de marque des documentsAjouter des logos d'entreprise, des en-têtes et des pieds de page aux documents PDF
• Génération de rapportsAjoutez des en-têtes et des pieds de page cohérents aux rapports générés.
• Documents commerciaux: Améliorez votre apparence professionnelle grâce à des en-têtes et des pieds de page personnalisés.
• Image de marque d'entrepriseAppliquer des en-têtes et des pieds de page cohérents à tous les documents commerciaux

Education & Research

Cas d'utilisation dans le domaine de l'éducation et de la recherche

• Articles académiquesAjouter des numéros de page, des en-têtes et des pieds de page aux publications académiques
• Documents de rechercheMettez en forme vos documents de recherche avec des en-têtes et des pieds de page appropriés.
• Mise en forme de la thèse: Ajouter des en-têtes et des pieds de page aux thèses et mémoires
• Matériel pédagogique: Améliorez les documents pédagogiques avec des en-têtes et des pieds de page

Finance & Banking

Cas d'utilisation dans le secteur financier et bancaire

• Rapports financiersAjoutez des en-têtes et des pieds de page aux rapports et états financiers.
• Mise en forme des factures: Appliquer des en-têtes et des pieds de page aux factures et aux documents financiers
• Documentation de conformité: Inclure les informations de conformité dans les en-têtes et les pieds de page
• Rapports d'auditAjoutez des en-têtes et des pieds de page professionnels aux rapports d'audit.

Obtenez de l'aide

Get Your API KeyAPI SamplesGetting Started