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

Remplacer du texte - Remplacement de texte API

PDF4me Remplacer le texte permet de rechercher et de remplacer du texte dans les documents Word grâce à des options de recherche avancées. API Ce service traite les fichiers Word et effectue de multiples opérations de remplacement avec correspondance sensible à la casse et correspondance de mots entiers. API reçoit le contenu des documents Word via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à la prise en charge de plusieurs opérations de recherche et de remplacement dans une seule requête, cette solution est idéale pour l'automatisation des documents, le traitement des modèles et les flux de travail de gestion de contenu.

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​

  • Remplacements de texte multiplesEffectuer plusieurs opérations de recherche et de remplacement en une seule action
  • Options de recherche avancée: Correspondance sensible à la casse et correspondance de mots entiers
  • Traitement séquentiel: Remplacements multiples traités dans l'ordre spécifié
  • Appariement flexibleCorrespondances exactes, correspondances partielles ou correspondances de mots entiers
  • Structure simple: Tableau facile à utiliser d'opérations de recherche et de remplacement

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 sont effectuées via un point de terminaison unique :

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

REST API Paramètres​

Liste complète des paramètres pour le texte de remplacement 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. phrases Le tableau doit contenir au moins une phrase de remplacement.

Paramètres requis​

ParamètreTaperDescriptionExemple
document*ObjectRéférence du document. Doit contenir Nom (string): Nom de fichier Word avec l'extension .docx{ "Name": "document.docx" }
docContent*Base64Contenu du document Word encodé en Base64Le remplacement de texte est effectué sur ce document.UEsDBBQABgAIAAAA...
phrases*ArrayTableau d'objets de remplacement. Doit contenir au moins un remplacement. Chaque remplacement est traité séquentiellement dans l'ordre spécifié.Voir l'exemple ci-dessous

Structure de l'objet de remplacement de texte (tableau de phrases)​

Chaque élément du phrases Le tableau doit être un objet ayant la structure suivante :

ParamètreTaperDescriptionExemple
trouverTexte*StringChaîne de texte à rechercher dans le document. Ne peut être nulle ni vide. Sensible ou insensible à la casse selon le paramètre matchCase. Toutes les occurrences de ce texte seront remplacées."old text"
remplacerTexteStringTexte de remplacement. Peut être une chaîne vide pour supprimer le texte trouvé. Par défaut : chaîne vide (supprime le texte trouvé)."new text"
matchCaseBooleanCorrespondance sensible à la casse. true = La recherche est sensible à la casse (correspondance exacte requise), false La recherche est insensible à la casse (par défaut). Permet de déterminer si « The » correspond à « the » ou uniquement à « The ».false
matchWholeWordBooleanCorrespondance des mots entiers. true = Ne faire correspondre que des mots complets (pas des correspondances partielles), false = Correspondance partielle avec des mots (par défaut). Empêche la correspondance entre « the », « there » et « other ».false

Paramètres optionnels​

ParamètreTaperDescriptionExemple
nom de la cultureStringCode culturel pour le traitement des documents (par exemple, "en-US", "de-DE", "fr-FR")en-US

Traitement de remplacement de texte​

  • Chaque remplacement est traité séquentiellement dans l'ordre spécifié
  • Plusieurs remplacements peuvent être effectués sur le même document.
  • Toutes les occurrences de la fonction Rechercher du texte sont remplacées (sauf si la correspondance avec le mot entier est utilisée).

Sortir​

Le PDF4me Remplacer le texte REST API renvoie des réponses différentes selon le mode de traitement. API renvoie le document Word sous forme de 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

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 les remplacements de texte appliqués, encodé comme Base64 chaîne
  • nom de fichier (string): Le nom du fichier Word de sortie
  • succès (boolean): Indique si la requête a abouti
  • message d'erreur (string ou null) : Détails de l’erreur en cas de succès faux

Mode d'emploi :

  1. Extraire le document champ du JSON réponse (Base64)
  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 selon les besoins

Exemple (JavaScript) :

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process 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 utiliser Authorization: Basic YWJjMTIz

Charge utile​

Exemple de base (remplacement unique) :

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "phrases": [
 {
 "findText": "old text",
 "replaceText": "new text",
 "matchCase": false,
 "matchWholeWord": false
 }
 ],
 "cultureName": "en-US"
}

Exemple avancé (remplacements multiples) :

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "phrases": [
 {
 "findText": "[COMPANY_NAME]",
 "replaceText": "Acme Corporation",
 "matchCase": false,
 "matchWholeWord": false
 },
 {
 "findText": "[DATE]",
 "replaceText": "2024-01-15",
 "matchCase": false,
 "matchWholeWord": false
 },
 {
 "findText": "[CONTACT_EMAIL]",
 "replaceText": "[email protected]",
 "matchCase": false,
 "matchWholeWord": false
 }
 ],
 "cultureName": "en-US"
}

Exemples de code​

Le PDF4me Remplacer le texte 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 le remplacement de texte dans les documents Word :

Cas d'utilisation et applications industrielles​

Cas d'utilisation des services juridiques et professionnels

  • Traitement des contrats: Remplacez le texte d'espace réservé par des informations spécifiques au client
  • Automatisation des documents juridiquesMettre à jour les numéros de dossier, les noms des clients et les dates.
  • Normalisation des modèles: Normaliser la terminologie et la mise en forme juridiques
  • Communication avec les clientsPersonnaliser les documents juridiques pour des clients spécifiques

Obtenez de l'aide​

Get Your API KeyAPI SamplesGetting Started