Aller au contenu principal
API PDF4meIntégrationsBase de connaissancesExtensionsTesteur d'APIBlog

Mise à jour des en-têtes et pieds de page - Gestion des en-têtes API

PDF4me Mettre à jour les en-têtes et les pieds de page vous permet d'ajouter ou de modifier des en-têtes et des pieds de page dans les documents Word grâce à des fonctionnalités complètes. HTML Prise en charge du contenu et options de style professionnelles. API Ce service traite les fichiers Word et applique des en-têtes et des pieds de page à différentes mises en page, y compris la première page, les pages paires/impaires et toutes les pages, avec application automatique d'un style professionnel par défaut. HTML Traitement du contenu et mise en forme flexible spécifique à chaque page. API reçoit le contenu des documents Word via REST API appels, utilisant Base64 encodage pour une transmission sécurisée. Avec prise en charge des champs de numéro de page (PAGE, NUMPAGES, SECTION, SECTIONPAGES), HTML Grâce à sa mise en forme et à son style professionnel automatique, cette solution est idéale pour l'image de marque des documents, la numérotation des pages et les flux de travail de présentation de documents professionnels.

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​

  • Plusieurs types de pages: Prise en charge de toutes les pages, de la première page, des pages paires/impaires
  • HTML Support du contenu: Riche HTML contenu avec un style professionnel
  • Style automatiqueStyle par défaut professionnel pour le contenu en texte brut
  • Champs de numéro de page: Soutien à PAGE, NUMPAGES, SECTION, SECTIONPAGES
  • Mise en page flexibleEn-têtes et pieds de page différents selon le type de page
  • Soutien culturelTraitement des documents en fonction des paramètres régionaux
  • Préservation du format: Préserve la structure originale du document
  • Apparence professionnelleApplication automatique de coiffure professionnelle

REST API Point de terminaison​

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

  • Méthode: POST
  • Point final : office/ApiV2Word/UpdateHeadersAndFooters

REST API Paramètres​

Liste complète des paramètres pour la mise à jour des en-têtes et pieds de page 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. Les paramètres avancés permettent un contrôle précis des en-têtes et pieds de page spécifiques à chaque page.

Paramètres requis​

ParamètreTaperDescriptionExemple
document*ObjectDescription du document. Doit inclure Nom (string): Nom du fichier Word de sortie avec l'extension .docx{ "Name": "document.docx" }
docContent*Base64Contenu du document Word encodé en Base64Des en-têtes et des pieds de page ont été ajoutés à ce document. Le document doit être un document Word valide (formats .docx ou .doc).base64EncodedDocumentContent

Paramètres optionnels (En-tête/Pied de page) HTML)​

ParamètreTaperDescriptionExemple
contenu de l'en-têteStringContenu d'en-tête simple (utilisé avec footerContent lorsque le format de contrôle isHtml/isHtmlMode est utilisé)"Company Name"
Pied de page ContenuStringContenu de pied de page simple"Page PAGE of NUMPAGES"
estHTMLBooleanQue le contenu de l'en-tête/du pied de page soit HTMLtrue
isHtmlModeBooleanUtiliser HTML mode de traitement du contenutrue
allPagesHeaderHtmlStringEn-tête HTML pour toutes les pages. Supporte PAGE, NUMPAGES, SECTION, SECTIONPAGES"<div style='text-align: center;'>Company Name</div>"
firstPageHeaderHtmlStringEn-tête HTML pour la première page seulement"<div style='text-align: center;'>Title Page</div>"
evenPagesHeaderHtmlStringEn-tête HTML pour les pages paires"<div style='text-align: right;'>Book Title</div>"
oddPagesHeaderHtmlStringEn-tête HTML pour les pages impaires"<div style='text-align: left;'>Chapter Title</div>"
allPagesFooterHtmlStringPied de page HTML pour toutes les pages"Page PAGE of NUMPAGES"
firstPageFooterHtmlStringPied de page HTML pour la première page seulement"<div style='text-align: center;'>Confidential</div>"
evenPagesFooterHtmlStringPied de page HTML pour les pages paires"<div style='text-align: center;'>Page PAGE</div>"
OddPagesFooterHtmlStringPied de page HTML pour les pages impaires"<div style='text-align: center;'>Page PAGE</div>"

Paramètres optionnels (en-tête/pied de page de texte)​

ParamètreTaperDescriptionExemple
En-tête de toutes les pagesObjectContenu d'en-tête saisi pour toutes les pages (HeaderFooterContentInUpdate)-
en-tête de première pageObjectEn-tête dactylographié pour la première page-
En-tête de page paire / En-tête des pages impairesObjectEn-tête dactylographié pour les pages paires/impaires-
Pied de page de toutes les pages / pied de page de première page / Pied de page des pages / Pied de page impairObjectContenu du pied de page par type de page-

Paramètres optionnels (Généraux)​

ParamètreTaperDescriptionExemple
nom de la cultureStringCode de culture pour le traitement des documents (par exemple, « en-US », « fr-FR », « de-DE »). Valeur par défaut : nulle. Affecte la langue et la mise en forme du document.en-US

HTML Support du contenu​

Le API supports HTML contenu dans tous les paramètres d'en-tête et de pied de page :

  • HTML Étiquettes: Standard HTML balises (div, span, p, b, i, u, etc.)
  • Style CSS: Styles CSS en ligne pour la mise en forme
  • Texte brutLe texte brut bénéficie automatiquement d'une mise en forme professionnelle par défaut.
  • Contenu mixte: Combiner HTML et du texte brut au besoin

Style par défaut pour le texte brut :

  • En-têtesAlignement à gauche, bordure inférieure, police de 10 px
  • Pieds de pageAlignement centré, bordure supérieure, police de 9 px

Options de mise en page​

Le API prend en charge différentes mises en page pour les en-têtes et les pieds de page :

Type de mise en pageDescriptionParamètres requis
Toutes les pagesMême en-tête/pied de page sur toutes les pagesallPagesHeaderHtml, allPagesFooterHtml (ou tapé) allPagesHeader, allPagesFooter)
Première pageEn-tête/pied de page différent sur la première pagefirstPageHeaderHtml, firstPageFooterHtml (ou leurs équivalents dactylographiés)
Pages paires/impairesEn-têtes/pieds de page différents pour les pages paires et impairesevenPagesHeaderHtml, oddPagesHeaderHtml, evenPagesFooterHtml, oddPagesFooterHtml (ou leurs équivalents dactylographiés)

Sortir​

Le PDF4me Mettre à jour les en-têtes et les pieds de page REST API renvoie un JSON réponse. En cas de succès, la API renvoie le document Word sous forme de Base64chaîne encodée dans le document champ (ApiV2WordApiCallRes), et non sous forme de données binaires.

Réponse réussie

Code d'état : 200 OK

Type de contenu : application/json

Corps de la réponse :

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

Champs de réponse :

  • document (string): Le document Word avec en-têtes et pieds de page mis à jour, encodé comme Base64
  • nom de fichier (string): Le nom du fichier Word de sortie
  • succès (boolean): Si l'opération a réussi
  • message d'erreur (string): Message d'erreur en cas d'échec ; sinon, valeur nulle

Mode d'emploi :

  1. Vérifier success; si vrai, extraire le document champ du JSON réponse
  2. Décodez le Base64 chaîne permettant d'obtenir les données binaires d'un document Word
  3. Enregistrez ou traitez le fichier Word en utilisant fileName

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

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 de base (en-tête et pied de page de toutes les pages) :

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

Exemple avancé (Première page + Pages paires/impaires) :

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

Exemple de contenu 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"
}

Exemple de texte brut (headerContent/footerContent) :

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

Exemples de code​

Le PDF4me Mettre à jour les en-têtes et les pieds de page 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# (CSharp) Échantillon

Complet C# Implémentation pour la mise à jour des en-têtes et pieds de page dans les documents Word :

Cas d'utilisation et applications industrielles​

Cas d'utilisation des services juridiques et professionnels

  • En-têtes de contratAjouter des mentions de confidentialité et des clauses de non-responsabilité légales
  • Documents judiciaires: Inclure les numéros de dossier et les informations de dépôt
  • Mémoires juridiquesAjouter les informations sur l'avocat et les détails de l'affaire
  • Rapports de conformitéInclure les informations réglementaires et les dates

Obtenez de l'aide​

Get Your API KeyAPI SamplesGetting Started