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

Mise à jour de la table des matières - TOC Gestion API

PDF4me Mise à jour de la table des matières vous permet de mettre à jour ou de créer une table des matières dans les documents Word grâce à des options de mise en forme complètes et des fonctionnalités de style professionnelles. API Ce service traite les fichiers Word et génère TOCs avec détection automatique des existants TOC champs, niveaux de titres personnalisables, prise en charge des hyperliens, contrôle du leader de tabulation, options de casse et localisation culturelle. API reçoit le contenu des documents Word via REST API appels, utilisant Base64 encodage pour une transmission sécurisée. Avec un contrôle total sur TOC Alliant esthétique et fonctionnalité, cette solution est idéale pour la navigation documentaire, la mise en forme professionnelle et l'automatisation. TOC flux de travail de génération.

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​

  • Automatique TOC Détection: Recherche et met à jour les données existantes TOC champs ou en crée de nouveaux
  • Niveaux de titres personnalisables: Contrôler les niveaux de titres à inclure (1-6)
  • Support des liens hypertextesActiver ou désactiver les liens cliquables dans le TOC
  • Contrôle du leader d'ongletAfficher ou masquer les points entre le texte et les numéros de page
  • Options de casse du texteUtilisez les majuscules ou conservez la casse d'origine.
  • Localisation culturelle: Prise en charge de différentes langues et régions
  • Mise en forme professionnelleApplication automatique de professionnels TOC style
  • Intégration des numéros de pageCalcul et mise à jour automatiques des numéros de page

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 mise à jour de la table des matières sont effectuées via un point de terminaison unique :

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

REST API Paramètres​

Liste complète des paramètres pour la mise à jour de la table des matières 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 de TOC mise en forme et apparence.

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 Base64. TOC Ce fichier est généré à partir des titres de ce document. Il doit s'agir d'un document Word valide (formats .docx ou .doc).UEsDBBQABgAIAAAA...

Paramètres optionnels​

ParamètreTaperDescriptionExemple
Niveaux d'en-têteStringNiveaux de titres à inclure dans TOCFormat de plage : « 1-3 » (incluant les niveaux de titre 1, 2 et 3). Niveau unique : « 1 ». Plages multiples : « 1-2, 4-6 ». Valeur par défaut : « 1-3 ». Correspond aux styles de titre intégrés de Word. Analyse le document à la recherche de titres existants. TOC champs. Crée de nouveaux TOC au début du document si aucun n'existe"1-3"
utiliser des hyperliensBooleanIncluez des hyperliens dans la table des matières. true = TOC Les entrées sont des liens cliquables (par défaut), false = texte bruttrue
masquer l'onglet principalBooleanMasquer les points de repère des onglets. true = Pas de points entre le texte et les numéros de page (par défaut), false = Points entre le texte et les numéros de pagetrue
useUppercaseBooleanUtilisez des majuscules pour TOC entrées. true = TOC entrées en majuscules (par défaut), false = cas d'originetrue
nom de la cultureStringCode de culture pour le traitement des documents (par exemple, « en-US », « de-DE », « fr-FR »). Valeur par défaut : nulle. Affecte la langue et la mise en forme du document.en-US

TOC Comportement de génération​

  • Existant TOC Détection: Numérise les documents pour les documents existants TOC champs (FieldType.FieldTOC) et les met à jour
  • Nouveau TOC Création: Si non TOC existe, crée du nouveau TOC au début du document
  • Cartographie des niveaux de direction: Correspond aux styles de titres intégrés de Word (Titre 1, Titre 2, etc.)
  • Mises à jour sur le terrain: Met à jour les champs plusieurs fois pour plus de précision
  • Mise en page: Appelle successivement UpdateFields() et UpdatePageLayout()

Sortir​

Le PDF4me Mise à jour de la table des matières 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 la table des matières mise à jour, 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 (paramètres par défaut) :

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

Exemple avancé (avec toutes les options) :

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-4",
 "useHyperlinks": true,
 "hideTabLeader": false,
 "useUppercase": false,
 "cultureName": "en-US"
}

Exemple de document académique :

{
 "document": { "Name": "research-paper.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-3",
 "useHyperlinks": true,
 "hideTabLeader": true,
 "useUppercase": true
}

Exemples de code​

Le PDF4me Mise à jour de la table des matières 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 la mise à jour de la table des matières dans les documents Word :

Cas d'utilisation et applications industrielles​

Cas d'utilisation des services juridiques et professionnels

  • Navigation contractuelleCréer une table des matières détaillée pour les contrats complexes
  • Mémoires juridiquesGénérer une structure navigable pour les documents judiciaires
  • Manuels de conformité: Index des exigences et procédures réglementaires
  • Documentation du dossierOrganiser les preuves et les arguments juridiques

Obtenez de l'aide​

Get Your API KeyAPI SamplesGetting Started