Remplacer du texte par une image - Remplacement d'image API
PDF4me Remplacer le texte par une image permet de remplacer du texte par des images dans des documents Word grâce à des options avancées de filtrage de page et de contrôle de la taille. API Ce service traite les fichiers Word et remplace les espaces réservés au texte par des images grâce à une correspondance de texte précise, un dimensionnement personnalisable avec préservation des proportions, un ciblage spécifique à la page et des options de filtrage flexibles. API reçoit le contenu des documents Word et les données d'image via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à la prise en charge de nombreux formats d'image et à un contrôle total du comportement de remplacement, cette solution est idéale pour l'automatisation des documents, le traitement des modèles et les flux de travail d'insertion dynamique de contenu.
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.
Caractéristiques principales
- Remplacement de texte en image: Remplacer des chaînes de caractères spécifiques par des images dans l'ensemble des documents
- Correspondance précise de texte: Recherche et remplacement de texte sensibles à la casse
- Contrôle de la taille de l'imagePersonnalisez les dimensions de l'image avec les paramètres de largeur et de hauteur.
- Préservation du rapport d'aspectConserver les proportions de l'image lors du redimensionnement
- Filtrage des pages: Cibler des pages ou des plages de pages spécifiques à remplacer
- Filtrage avancé: Ignorer la première page, cibler les pages paires/impaires ou spécifier les numéros de page exacts
- Formats d'image multiples: Soutien à PNG, JPG, JPEG, BMP, GIF formats
- Positionnement flexible: Insérez des images sous forme de formes Word avec un positionnement précis
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 remplacement de texte par image sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
office/ApiV2Word/ReplaceTextWithImage
REST API Paramètres
Liste complète des paramètres pour le remplacement de texte par une image 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 du dimensionnement des images et du filtrage des pages.
Paramètres requis
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| document* | Object | Description du document. Doit inclure Nom (string): Nom du fichier Word de sortie avec l'extension .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Contenu du document Word encodé en Base64Un remplacement de texte est effectué sur ce document. Doit être un document Word valide (formats .docx ou .doc). | base64EncodedDocumentContent |
| trouverTexte* | String | Chaîne de texte à rechercher dans le document. Sensible à la casse. Toutes les occurrences seront remplacées par l'image. Ne peut être nulle ni vide. Exemples : « [LOGO] », « SIGN_HERE ». | "text to replace" |
| contenu de l'image* | Base64 | Contenu du fichier image de remplacement encodé en Base64. Doit être une image valide (PNG, JPG, JPEG, BMP, GIF) | base64EncodedImageContent |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| largeur | Nombre (double) | Largeur de l'image | 200 |
| hauteur | Nombre (double) | Hauteur de l'image | 100 |
| maintenirAspectRatio | Boolean | Conserver les proportions de l'image lors du redimensionnement. Valeur par défaut : vrai | true |
| skipFirstPage | Boolean | Ignorer le remplacement sur la première page. true = passer la première page, false = inclure (par défaut). Utile pour les pages de couverture/titre | false |
| postuler | String | Lunette de visée de remplacement | - |
| Numéros de page | String | Numéros de page ou plages de pages spécifiques (par exemple, « 1,2,3 » ou « 1,3,5-7 »). Vide = toutes les pages | "1,2,3" |
| ignorer les numéros de page | String | Numéros de page à exclure du remplacement | - |
| nom de la culture | String | Code culturel (par exemple, « en-US », « fr-FR », « de-DE »). Par défaut : nul | en-US |
Filtrage des pages
Le API prend en charge le filtrage des pages via les paramètres suivants :
- skipFirstPage: Permet de contrôler si la première page doit être ignorée
- Numéros de page: Spécifie les pages à traiter (chaîne vide = toutes les pages)
- ignorer les numéros de pageNuméros de page à exclure
Formats d'image pris en charge
Remplacer le texte par une image API prend en charge différents formats d'image pour une compatibilité maximale :
| Format | Extension | Description |
|---|---|---|
| PNG | .png | Portable Network Graphics (PNG) – idéal pour les logos et les graphiques avec transparence. |
| JPEG | .jpg, .jpeg | Groupe d'experts photographiques conjoint - idéal pour les photographies et les images complexes |
| BMP | .bmp | Bitmap - format non compressé, fichiers plus volumineux |
| GIF | .gif | Format d'échange graphique (GIF) - prend en charge l'animation et la transparence |
Sortir
Le PDF4me Remplacer le texte par une image REST API renvoie un JSON réponse (ApiV2WordApiCallRes). En cas de succès, API renvoie le document Word sous forme de Base64chaîne encodée dans le document champ, et non sous forme de données binaires.
- Success Response
- Error Responses
- Response Format Details
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 dont le texte a été remplacé par des images, 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 :
- Vérifier
success; si vrai, extraire ledocumentchamp du JSON réponse - Décodez le Base64 chaîne permettant d'obtenir les données binaires d'un document Word
- 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 wordBytes = atob(data.document);
// Save or process wordBytes
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 (
document,docContent,trouverTexte,contenu de l'image) - FindText est nul ou vide
- ImageContent est nul ou vide
- Invalide Base64 encodage dans
docContentoucontenu de l'image - Document Word invalide ou corrompu
- Fichier image invalide ou corrompu
- Aucune page ne correspond aux critères de filtrage
- 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
- Échec du traitement du document Word
- Échec du remplacement de texte
- Échec de l'insertion de l'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 directement de données Word binaires.
Structure de réponse (ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": null
}
En-tête Content-Type :
- Succès:
application/json - Le document Word 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 vers un document Word :
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, wordBytes);
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": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"cultureName": "en-US"
}
Exemple avancé (avec champs facultatifs) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"width": 200,
"height": 100,
"maintainAspectRatio": true,
"skipFirstPage": true,
"pageNumbers": "1,2,3",
"ignorePageNumbers": null,
"cultureName": "en-US"
}
Exemples de code
Le PDF4me Remplacer le texte par une image 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
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Échantillon
Complet C# Mise en œuvre d'une méthode de remplacement du texte par des images dans les documents Word :
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:
Google Script Échantillon
Google Apps Script mise en œuvre pour Google Workspace intégration :
Cas d'utilisation et applications industrielles
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Cas d'utilisation des services juridiques et professionnels
- Traitement des contrats: Remplacer les espaces réservés aux signatures par des signatures autorisées
- Automatisation des documents juridiquesInsérer les logos et filigranes de l'entreprise dans les documents juridiques
- Personnalisation des documents clients: Ajouter des images spécifiques au client aux documents juridiques
- Documentation de conformitéApposer les cachets et sceaux de conformité sur les documents
Cas d'utilisation en entreprise
- Génération de propositionsInsérer les logos de l'entreprise et les images des produits dans les propositions
- Création de matériel marketing: Remplacez le texte d'espace réservé par des images marketing
- Automatisation de la présentation clientInsérer des images spécifiques au client dans les présentations
- Génération de rapports de ventesInsérer des graphiques et des tableaux de ventes dans les rapports
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Génération de rapports médicauxInsérer les graphiques et schémas médicaux dans les rapports
- Traitement des documents des patientsInsérer les logos des établissements médicaux dans les documents des patients
- Documentation de rechercheInsérer des tableaux et des graphiques de recherche dans les articles de recherche
- Documentation de conformitéInsérer les cachets de conformité médicale dans les documents
Cas d'utilisation dans le secteur financier et bancaire
- Génération de rapports financiersInsérer des graphiques et des tableaux dans les rapports financiers
- Traitement des factures: Remplacez les espaces réservés aux logos par les logos de l'entreprise
- Documentation d'auditInsérer les cachets et signatures d'audit dans les rapports d'audit
- Automatisation des rapports budgétairesInsérer des graphiques budgétaires dans les documents budgétaires