Passa al contenuto principale
PDF4me APIIntegrazioniBase di conoscenzaEstensioniTester APIBlog

Aggiorna l'indice - TOC Gestione API

PDF4me Aggiorna l'indice. consente di aggiornare o creare indici nei documenti Word con opzioni di formattazione complete e funzionalità di stile professionali. API il servizio elabora i file Word e genera TOCcon rilevamento automatico di quelli esistenti TOC campi, livelli di intestazione personalizzabili, supporto per collegamenti ipertestuali, controllo del leader di tabulazione, opzioni di maiuscole/minuscole e localizzazione culturale. API riceve il contenuto del documento Word tramite REST API chiamate, utilizzando Base64 codifica per trasmissione sicura. Con pieno controllo su TOC aspetto e funzionalità, questa soluzione è ideale per la navigazione dei documenti, la formattazione professionale e l'automazione TOC flussi di lavoro di generazione.

Articoli correlati del blog
Non ci sono ancora post sul blog dedicati a questa funzionalità — in arrivo a breve.
Nel frattempo, dai un'occhiata al blog di PDF4me per trovare tutorial e procedure operative su tutte le piattaforme.
Visita il blog →

Autenticazione del tuo API Richiesta​

Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.

Get your api Key

Caratteristiche principali​

  • Automatic TOC Rilevamento: Trova e aggiorna quelli esistenti TOC campi o ne crea di nuovi
  • Livelli di direzione personalizzabili: Seleziona i livelli di intestazione da includere (1-6)
  • Supporto per i collegamenti ipertestuali: Abilita o disabilita i collegamenti cliccabili nel TOC
  • Controllo del leader della schedaMostra o nascondi i punti tra il testo e i numeri di pagina
  • Opzioni maiuscole/minuscole: Utilizzare le maiuscole o mantenere la maiuscola originale
  • Localizzazione culturaleSupporto per diverse lingue e regioni
  • Formattazione professionale: Applicazione automatica professionale TOC stile
  • Integrazione dei numeri di paginaCalcolo e aggiornamento automatici del numero di pagina

REST API Punto finale​

IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di aggiornamento dell'indice vengono eseguite tramite un unico endpoint:

  • Metodo: POST
  • Punto finale: office/ApiV2Word/UpdateTableOfContents

REST API Parametri​

Elenco completo dei parametri per l'aggiornamento del sommario REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.

Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori. I parametri avanzati forniscono un controllo preciso su TOC formattazione e aspetto.

Parametri richiesti​

ParametroTipoDescrizioneEsempio
documento*ObjectRiferimento al documento. Deve contenere Nome string): Nome del file Word con estensione .docx{ "Name": "document.docx" }
docContent*Base64Il contenuto del documento Word codificato in Base64. TOC viene generato dalle intestazioni di questo documento. Deve essere un documento Word valido (formati .docx, .doc).UEsDBBQABgAIAAAA...

Parametri opzionali​

ParametroTipoDescrizioneEsempio
livelli di intestazioneStringLivelli di intestazione da includere in TOCFormato intervallo: "1-3" (include i livelli di intestazione 1, 2 e 3). Livello singolo: "1". Intervalli multipli: "1-2,4-6". Predefinito: "1-3". Corrisponde agli stili di intestazione predefiniti di Word. Analizza il documento per individuare quelli esistenti. TOC campi. Crea nuovi TOC all'inizio del documento se non esiste"1-3"
utilizzare i collegamenti ipertestualiBooleanInserisci i collegamenti ipertestuali nell'indice. true = TOC Le voci sono collegamenti cliccabili (impostazione predefinita), false = testo semplicetrue
nascondiTabLeaderBooleanNascondi i punti di riferimento della tabulazione. true = Nessun punto tra il testo e i numeri di pagina (impostazione predefinita), false = Punti tra il testo e i numeri di paginatrue
usa le maiuscoleBooleanUtilizzare le maiuscole per TOC voci. true = TOC voci in maiuscolo (predefinito), false = caso originaletrue
Nome della culturaStringCodice cultura per l'elaborazione dei documenti (ad esempio, "en-US", "de-DE", "fr-FR"). Valore predefinito: null. Influisce sulla lingua e sulla formattazione del documento.en-US

TOC Comportamento generazionale​

  • Esistente TOC Rilevamento: Scansiona il documento per individuare quello esistente TOC campi (FieldType.FieldTOC) e li aggiorna
  • Nuovo TOC Torre: Se no TOC esiste, crea nuovo TOC all'inizio del documento
  • Mappatura del livello di intestazione: Corrisponde agli stili di intestazione predefiniti di Word (Intestazione 1, Intestazione 2, ecc.)
  • Aggiornamenti dal campoAggiorna i campi più volte per garantirne la precisione.
  • Layout di pagina: Chiama UpdateFields() e UpdatePageLayout() in sequenza

Produzione​

IL PDF4me Aggiorna l'indice. REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il documento Word come un Base64-stringa codificata in JSON formato, non come dati binari.

Elaborazione sincrona (impostazione predefinita)

IL API elabora la richiesta e restituisce:

Codice di stato: 200 OK

Tipo di contenuto: application/json

Corpo della risposta:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

Campi di risposta:

  • documento string): Il documento Word con l'indice aggiornato, codificato come Base64 corda
  • Nome file string): Il nome del file Word di output
  • successo boolean): Indica se la richiesta è andata a buon fine
  • messaggio di errore string o null): Dettagli dell'errore quando il successo è falso

Come si usa:

  1. Estrarre il document campo dal JSON risposta (Base64)
  2. decodificare il Base64 stringa per ottenere i dati binari del documento Word
  3. Salva o elabora il file Word secondo necessità.

Esempio (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes

Esempio di richiesta​

Intestazione​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
  • IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
  • Esempio: se il tuo API la chiave è abc123, codificalo in Base64 e utilizzare Authorization: Basic YWJjMTIz

Carico utile​

Esempio di base (impostazioni predefinite):

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

Esempio avanzato (con tutte le opzioni):

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

Esempio di articolo accademico:

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

Esempi di codice​

IL PDF4me Aggiorna l'indice. REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:

C# CSharp) Campione

Completo C# Implementazione per l'aggiornamento dell'indice nei documenti Word:

Casi d'uso e applicazioni industriali​

Casi d'uso per servizi legali e professionali

  • Navigazione a contratto: Creare un indice dettagliato per contratti complessi
  • Note legaliGenera una struttura navigabile per i documenti giudiziari.
  • Manuali di conformità: Requisiti e procedure di regolamentazione dell'indice
  • Documentazione del casoOrganizzare le prove e le argomentazioni legali

Richiedi assistenza​

Get Your API KeyAPI SamplesGetting Started