Aller au contenu principal

Ajouter une image à l'en-tête et au pied de page - Excel API

PDF4me Ajouter une image en-tête et pied de page vous permet d'ajouter des en-têtes et des pieds de page d'images personnalisables Excel Des documents avec un contrôle complet du positionnement et de la mise en forme. API processus de service Excel Il permet d'ajouter des en-têtes ou des pieds de page d'images aux fichiers, avec contrôle de leur placement (en-tête/pied de page), alignement horizontal (gauche, centre, droite), ciblage des feuilles de calcul (feuilles spécifiques ou toutes les feuilles) et marges de page en centimètres. API reçoit Excel contenu de document et données d'image via REST API appels, utilisant Base64 encodage pour une transmission sécurisée. Avec prise en charge de PNG, JPG, JPEGCompatible avec les formats d'image GIF et autres formats similaires, cette solution est idéale pour l'image de marque d'entreprise, les rapports professionnels et les flux de travail d'automatisation des documents.

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

Incluez votre API clé dans la requête pour s'authentifier auprès du PDF4me REST API.

Caractéristiques principales

  • Emplacement de l'en-tête ou du pied de page: Choisissez si vous souhaitez placer les images dans l'en-tête ou le pied de page du document.
  • Contrôle de positionAlignez les images à gauche, au centre ou à droite dans la zone d'en-tête/de pied de page.
  • Feuille de travail Ciblage: Appliquer des images à des feuilles de calcul spécifiques par nom ou index, ou à toutes les feuilles de calcul
  • Personnalisation des margesConfigurez les marges de la page (haut, bas, gauche et droite) en centimètres.
  • Prise en charge des formats d'image: PNG, JPG, JPEGet les formats GIF

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'en-tête/pied de page d'image pour Excel sont réalisées via un point de terminaison unique :

  • Méthode: POST
  • Point final : office/ApiV2Excel/ExcelAddImageHeaderFooter

REST API Paramètres

Important: Les paramètres marqués d'un astérisque (*) sont obligatoires. Toutes les requêtes utilisent document, docContent, contenu de l'image (niveau racine), et ajouterImageHeaderFooterToExcelActionLes autres options sont des propriétés de l'objet action.

Paramètres requis (niveau racine)

ParamètreTaperDescriptionExemple
document*ObjectRéférence du document. Doit contenir Nom (chaîne): Excel Nom de fichier avec l'extension .xlsx ou .xls{ "Name": "data.xlsx" }
docContent*String (Base64)Excel contenu du document encodé en Base64UEsDBBQABgAIAAAA...
contenu de l'image*String (Base64)Contenu du fichier image encodé en Base64. Soutient PNG, JPG, JPEG, formats GIFiVBORw0KGgoAAAANS...
ajouterImageHeaderFooterToExcelAction*ObjectConfiguration de l'action (position, ciblage de la feuille de calcul, marges, etc.)Voir l'exemple de charge utile ci-dessous

Paramètres optionnels (dans addImageHeaderFooterToExcelAction)

ParamètreTaperDescriptionExemple
estEn-têteBooleanSélection du stage. true = Ajouter une image à l'en-tête du document (par défaut), false Ajouter une image au pied de page du documenttrue
positionStringAlignement horizontal dans l'en-tête/le pied de page. Gauche, Centre, ou DroiteValeur par défaut : « Centre ». Insensible à la casseCenter
Noms des feuilles de travailArray (chaîne[])Tableau des noms des feuilles de calcul auxquelles appliquer l'image. Si les champs worksheetNames et worksheetIndexes sont vides, l'image sera appliquée à toutes les feuilles de calcul.["Sheet1", "Report"]
Index des feuilles de calculArray (int[])Tableau des index des feuilles de calcul (à partir de 1). Si les champs worksheetNames et worksheetIndexes sont vides, la valeur s'applique à toutes les feuilles de calcul.[1, 2]
marge supérieureNombre (double)Marge supérieure de la page en centimètres. Par défaut : 1,91.9
Marge inférieureNombre (double)Marge inférieure de la page en centimètres. Par défaut : 1,91.9
Marge gaucheNombre (double)Marge gauche de la page en centimètres. Par défaut : 1,91.9
marge de droiteNombre (double)Marge droite de la page en centimètres. Par défaut : 1,91.9
nom de la cultureStringCode culturel pour le traitement des documents (par exemple, "en-US", "de-DE", "fr-FR")en-US

Note: Si les deux Noms des feuilles de travail et Index des feuilles de calcul si les champs sont vides ou nuls, l'image sera appliquée à toutes les feuilles de calcul. Excel déposer.

Sortir

Le PDF4me Ajouter une image en-tête et pied de page REST API renvoie le Excel document comme un Base64chaîne encodée dans JSON format, et non sous forme de données binaires.

Traitement synchrone (par défaut)

Le API traite la requête et renvoie :

Code d'état : 200 OK

Content-Type: application/json

Corps de la réponse :

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

Champs de réponse :

  • document (chaîne de caractères) : Le Excel document avec en-tête/pied de page image appliqué, encodé comme Base64 chaîne
  • nom de fichier (chaîne de caractères) : La sortie Excel nom de fichier
  • succès (booléen) : Indique si la requête a abouti.
  • message d'erreur (chaîne de caractères ou null) : Détails de l’erreur en cas d’échec

Mode d'emploi :

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

Exemple (JavaScript):

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

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) :

{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {}
}

Exemple avancé (avec tous les champs facultatifs) :

{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {
"isHeader": true,
"position": "Center",
"worksheetNames": ["Sheet1", "Report"],
"worksheetIndexes": [1, 2],
"topMargin": 1.9,
"bottomMargin": 1.9,
"leftMargin": 1.9,
"rightMargin": 1.9,
"cultureName": "en-US"
}
}

Exemples de code

Le PDF4me Ajouter une image à l'en-tête et au pied de page Excel 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# Exemple (CSharp)

Complet C# implémentation pour l'ajout d'en-têtes/pieds de page d'images Excel documents :

Cas d'utilisation et applications industrielles

Cas d'utilisation en finance et comptabilité

  • États financiersAjouter le logo de l'entreprise en en-tête des rapports trimestriels
  • Rapports budgétairesInsérer les logos des départements sur les feuilles de calcul budgétaires
  • Documents d'audit: Appliquer le logo du cabinet d'audit en filigrane dans les pieds de page
  • Notes de fraisAjouter le logo de l'entreprise en en-tête des notes de frais

Obtenez de l'aide