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.
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ètre | Taper | Description | Exemple |
|---|---|---|---|
| document* | Object | Ré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 Base64 | UEsDBBQABgAIAAAA... |
| contenu de l'image* | String (Base64) | Contenu du fichier image encodé en Base64. Soutient PNG, JPG, JPEG, formats GIF | iVBORw0KGgoAAAANS... |
| ajouterImageHeaderFooterToExcelAction* | Object | Configuration 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ètre | Taper | Description | Exemple |
|---|---|---|---|
| estEn-tête | Boolean | Sé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 document | true |
| position | String | Alignement horizontal dans l'en-tête/le pied de page. Gauche, Centre, ou DroiteValeur par défaut : « Centre ». Insensible à la casse | Center |
| Noms des feuilles de travail | Array (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 calcul | Array (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érieure | Nombre (double) | Marge supérieure de la page en centimètres. Par défaut : 1,9 | 1.9 |
| Marge inférieure | Nombre (double) | Marge inférieure de la page en centimètres. Par défaut : 1,9 | 1.9 |
| Marge gauche | Nombre (double) | Marge gauche de la page en centimètres. Par défaut : 1,9 | 1.9 |
| marge de droite | Nombre (double) | Marge droite de la page en centimètres. Par défaut : 1,9 | 1.9 |
| nom de la culture | String | Code 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.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
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 :
- Extraire le
documentchamp du JSON réponse (Base64) - Décodez le Base64 chaîne permettant d'obtenir le binaire Excel données du document
- 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
Traitement asynchrone
Comportement asynchrone (202) Accepted (avec interrogation) est contrôlé par la configuration du serveur, et non par un paramètre du corps de la requête. Lorsqu'il est activé, le API peut renvoyer un statut 202 avec un sondage URL dans le Location En-tête. Interroger l'en-tête. URL avec GET demandes jusqu'à ce que vous en receviez 200 OK avec la même forme de réponse (document, nom_de_fichier, succès, message_d'erreur).
Réponses d'erreur
Le API retours standard HTTP codes d'erreur avec détails de l'erreur :
- Paramètres de requête invalides
- Champs obligatoires manquants (
documentavecNom,docContent,contenu de l'image,ajouterImageHeaderFooterToExcelAction) - Invalide Base64 encodage dans
docContentoucontenu de l'image - Invalide ou corrompu Excel document
- Fichier image invalide ou corrompu
- Sélection de feuille de calcul invalide (les noms ou les index n'existent pas ou sont hors limites).
- Invalide ou manquant API clé
- API clé non correctement Base64 encodé dans Authorization en-tête
- Manquant
Autorisation : de baseen-tête
- Erreur de traitement côté serveur
- Excel échec du traitement du document
- Échec de l'ajout d'en-tête/pied de page d'image
Format de réponse en cas d'erreur :
{
"error": "Error message describing what went wrong"
}
Détails du format de réponse
Important: Le API toujours retourne JSON, jamais binaire Excel données directement.
Structure de la réponse :
{
"document": "string", // Base64-encoded Excel document content
"fileName": "string", // Output Excel filename
"success": true,
"errorMessage": "string or null"
}
Décodage Base64 à Excel Document:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
excel_bytes = base64.b64decode(response['document'])
with open('output.xlsx', 'wb') as f:
f.write(excel_bytes)
C#:
byte[] excelBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.xlsx", 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 utiliserAuthorization: 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#
- Java
- JavaScript
- Python
C# Exemple (CSharp)
Complet C# implémentation pour l'ajout d'en-têtes/pieds de page d'images Excel documents :
Java Échantillon
Java implémentation avec gestion complète des erreurs et traitement des réponses :
JavaScript Échantillon
Node.js et compatible avec les navigateurs JavaScript mise en œuvre:
Python Échantillon
Python implémentation avec la bibliothèque requests et JSON manutention:
Cas d'utilisation et applications industrielles
- Finance & Accounting
- Sales & Marketing
- Human Resources
- Operations & Manufacturing
- Healthcare & Medical
- Legal & Professional Services
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
Cas d'utilisation en vente et marketing
- Rapports de venteInsérer les logos de la marque de l'entreprise sur les rapports de ventes hebdomadaires
- Grilles tarifairesAjouter des en-têtes de logo aux documents de tarification client
- Rapports marketingAppliquer les logos de campagne aux rapports d'analyse
- Présentations aux clientsAjouter les logos de co-branding du client aux livrables
Cas d'utilisation des ressources humaines
- Rapports de paieInsérer le logo de l'entreprise en en-tête des documents de paie
- Dossiers des employésAjouter le logo du service RH aux modèles de personnel
- Inscription aux avantages sociaux: Apposez les logos des fournisseurs de prestations sur les fiches d'inscription
- Évaluations de performance: Ajouter la marque de l'entreprise aux modèles d'avis
Cas d'utilisation en matière d'opérations et de fabrication
- Rapports d'inventaireInsérer les logos des entrepôts sur les fiches d'inventaire.
- Rapports de productionAjouter les logos des sites de production aux rapports de fabrication
- Rapports de qualité: Appliquer les logos de certification de qualité dans les en-têtes
- Rapports sur la chaîne d'approvisionnementAjouter les logos des fournisseurs aux documents d'approvisionnement
Cas d'utilisation dans le domaine de la santé et du médical
- Rapports des patientsAjouter le logo de l'hôpital ou de la clinique aux données des patients
- Résultats de laboratoireInsérer le logo du laboratoire sur les feuilles de résultats d'analyse.
- Réclamations d'assurance: Apposer les logos des assureurs sur les documents de réclamation
- Dossiers médicauxAjouter le logo de l'établissement aux fiches d'information sanitaire
Cas d'utilisation des services juridiques et professionnels
- Rapports clientsInsérer le logo du cabinet d'avocats en en-tête des documents livrables aux clients
- Documents de l'affaireAjouter les logos des domaines de pratique aux dossiers juridiques
- Modèles de contratsAppliquer l'identité visuelle de l'entreprise aux feuilles de travail contractuelles
- Relevés de facturationInsérer le logo de l'entreprise sur les rapports de facturation juridique