Ajouter du texte en-tête et pied de page - Excel API
PDF4me Ajouter du texte En-tête Pied de page vous permet d'ajouter des en-têtes et des pieds de page de texte personnalisables Excel Des documents avec un contrôle complet de la mise en forme. API processus de service Excel Il permet de modifier des fichiers et d'ajouter du texte aux sections d'en-tête ou de pied de page en définissant le style de police (famille, taille, couleur), les niveaux de transparence, les angles de rotation et les options d'orientation (horizontale, verticale, diagonale, à l'envers). API reçoit Excel contenu du document via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Cette solution est idéale pour l'intégration de la marque dans les documents, la numérotation des pages, les dates et les flux de travail de présentation professionnels.
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
- Contenu textuel personnalisé: Ajoutez n'importe quel texte comme en-tête ou pied de page sur Excel documents
- Personnalisation des polices: Contrôler la famille de polices, la taille, la couleur et les noms de polices spécifiques
- Contrôle de la transparence: Définir un texte semi-transparent (50 % d'opacité) ou totalement opaque (100 %)
- Rotation et orientation: Appliquer des angles de rotation ou des orientations prédéfinies (horizontale, verticale, diagonale, à l'envers)
- Soutien culturelSpécifiez les codes de culture pour un rendu et une mise en forme corrects du texte.
REST API Point de terminaison
- Méthode: POST
- Point final :
office/ApiV2Excel/ExcelAddTextHeaderFooter
REST API Paramètres
Important: Les paramètres marqués d'un astérisque (*) sont obligatoires. Toutes les requêtes utilisent document, docContentet un objet d'action. Les paramètres spécifiques à l'opération sont des propriétés de addTextHeaderFooterToExcelAction.
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... |
| addTextHeaderFooterToExcelAction* | Object | Configuration de l'action. Doit contenir au moins filigraneTexte (chaîne de caractères) : texte à afficher en en-tête ou en pied de page | Voir l'exemple de charge utile ci-dessous |
Paramètres optionnels (dans addTextHeaderFooterToExcelAction)
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| famille de polices | String | Nom de la famille de polices (par exemple, Arial, Times New Roman). Par défaut : Arial | Arial |
| taille de police | Nombre | Taille de la police en points (8 à 72). Par défaut : 72 | 12 |
| couleur de police | String | Code couleur hexadécimal ou nom de la couleur. Par défaut : noir. | #0000FF |
| semi-transparent | Boolean | vrai = opacité de 50 %, faux = 100 % (par défaut) | false |
| rotation | Nombre | Angle de rotation en degrés (0-360). Valeur par défaut : 0 | 45 |
| nom de police | String | Nom de police spécifique (remplace fontFamily) | Arial Bold |
| orientation | String | Horizontal, Verticale, Diagonale, ou À l'enversPriorité sur la rotation | Horizontal |
| nom de la culture | String | Code de culture pour le rendu du texte (par exemple, « en-US », « de-DE ») | en-US |
Sortir
Le API renvoie le Excel document en tant que Base64chaîne encodée dans JSON format.
- Success Response
- Error Responses
Code d'état : 200 OK
Corps de la réponse :
{
"document": "UEsDBBQABgAIAAAA...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
400 Bad RequestParamètres invalides, champs obligatoires manquants, invalide Base64 ou document. 401 Unauthorized: Invalide ou manquant API clé. 500 Internal Server ErrorErreur de traitement côté serveur.
Exemple de requête
En-tête
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Charge utile (basique)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024"
}
}
Charge utile (avec mise en forme optionnelle)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"addTextHeaderFooterToExcelAction": {
"watermarkText": "Confidential Report 2024",
"fontFamily": "Arial",
"fontSize": 12,
"fontColor": "#0000FF",
"orientation": "Horizontal"
}
}
Exemples de code
- GitHub