Saltar al contenido principal
PDF4me APIIntegracionesBase de conocimientosExtensionesProbador de APIBlog

Actualizar tabla de contenido - TOC Gestión API

PDF4me Actualizar tabla de contenido Le permite actualizar o crear tablas de contenido en documentos de Word con opciones de formato completas y capacidades de estilo profesional. API El servicio procesa archivos de Word y genera TOCs con detección automática de existentes TOC campos, niveles de encabezado personalizables, compatibilidad con hipervínculos, control de tabulaciones, opciones de mayúsculas y minúsculas, y localización cultural. El API recibe el contenido del documento de Word a través de REST API llamadas, utilizando Base64 codificación para transmisión segura. Con control total sobre TOC Por su apariencia y funcionalidad, esta solución es ideal para la navegación de documentos, el formato profesional y la automatización. TOC flujos de trabajo de generación.

Entradas de blog relacionadas
Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.
Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.
Visita el blog →

Autenticando su API Pedido​

Para acceder al PDF4me REST APICada solicitud debe incluir las credenciales de autenticación adecuadas. La autenticación garantiza una comunicación segura y valida su identidad como usuario autorizado del sistema. REST API.

Get your api Key

Características principales​

  • Automático TOC Detección: Busca y actualiza los existentes TOC campos o crea otros nuevos
  • Niveles de encabezado personalizables: Controla qué niveles de encabezado incluir (1-6)
  • Soporte para hipervínculos: Habilitar o deshabilitar los enlaces clicables en el TOC
  • Control de líder de tabulación: Mostrar u ocultar los puntos entre el texto y los números de página
  • Opciones de mayúsculas y minúsculas: Utilice mayúsculas o conserve el formato original
  • Localización cultural: Compatibilidad con diferentes idiomas y regiones
  • Formato profesional: Aplicación automática de profesionales TOC estilismo
  • Integración del número de páginaCálculo y actualización automáticos del número de página

REST API Punto final​

El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de actualización de la tabla de contenido se realizan a través de un único punto final:

  • Método: POST
  • Punto final: office/ApiV2Word/UpdateTableOfContents

REST API Parámetros​

Lista completa de parámetros para la actualización de la tabla de contenido. REST APILos parámetros están organizados por categoría para una mejor comprensión e implementación.

Importante: Los parámetros marcados con un asterisco (*) son obligatorios. Los parámetros avanzados proporcionan un control preciso sobre TOC formato y apariencia.

Parámetros requeridos​

ParámetroTipoDescripciónEjemplo
documento*ObjectReferencia del documento. Debe contener Nombre (string): Nombre del archivo de Word con extensión .docx{ "Name": "document.docx" }
docContent*Base64Contenido del documento de Word codificado en Base64. TOC Se genera a partir de los encabezados de este documento. Debe ser un documento de Word válido (formatos .docx o .doc).UEsDBBQABgAIAAAA...

Parámetros opcionales​

ParámetroTipoDescripciónEjemplo
niveles de encabezadoStringNiveles de encabezado a incluir en TOCFormato de rango: "1-3" (incluye los niveles de encabezado 1, 2 y 3). Nivel único: "1". Rangos múltiples: "1-2, 4-6". Predeterminado: "1-3". Se asigna a los estilos de encabezado integrados de Word. Escanea el documento en busca de encabezados existentes. TOC campos. Crea nuevos TOC al inicio del documento si no existe"1-3"
usar hipervínculosBooleanIncluya hipervínculos en la tabla de contenido. true = TOC Las entradas son enlaces clicables (predeterminado), false = texto planotrue
ocultarLíder de pestañaBooleanOcultar los puntos de referencia de las pestañas. true = Sin puntos entre el texto y los números de página (predeterminado), false = Puntos entre el texto y los números de páginatrue
usar mayúsculasBooleanUtilice mayúsculas para TOC entradas. true = TOC entradas en mayúsculas (predeterminado), false = caso originaltrue
Nombre de la culturaStringCódigo cultural para el procesamiento de documentos (p. ej., "en-US", "de-DE", "fr-FR"). Valor predeterminado: nulo. Afecta al idioma y al formato del documento.en-US

TOC Comportamiento generacional​

  • Existente TOC Detección: Escanea el documento para detectar documentos existentes TOC campos (FieldType.FieldTOC) y los actualiza
  • Nuevo TOC Creación: Si no TOC existe, crea nuevos TOC al inicio del documento
  • Mapeo de niveles de encabezado: Se corresponde con los estilos de encabezado integrados de Word (Encabezado 1, Encabezado 2, etc.).
  • Actualizaciones de campoActualiza los campos varias veces para mayor precisión.
  • Diseño de páginaLlama a UpdateFields() y UpdatePageLayout() en secuencia.

Producción​

El PDF4me Actualizar tabla de contenido REST API devuelve diferentes respuestas según el modo de procesamiento. API devuelve el documento de Word como un Base64cadena codificada en JSON formato, no como datos binarios.

Procesamiento síncrono (predeterminado)

El API procesa la solicitud y devuelve:

Código de estado: 200 OK

Tipo de contenido: application/json

Cuerpo de la respuesta:

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

Campos de respuesta:

  • documento (string): El documento de Word con la tabla de contenido actualizada, codificada como Base64 cadena
  • Nombre del archivo (string): El nombre del archivo de Word de salida
  • éxito (boolean): Indica si la solicitud se realizó correctamente
  • mensaje de error (string o nulo): Detalles del error cuando el éxito es falso

Cómo usarlo:

  1. Extraer el document campo del JSON respuesta (Base64)
  2. Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
  3. Guarde o procese el archivo de Word según sea necesario.

Ejemplo (JavaScript):

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

Ejemplo de solicitud​

Encabezamiento​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Consigue tu API clave del PDF4me Panel
  • El API La clave debe ser Base64 codificado y prefijado con "Basic" en el Authorization encabezado
  • Ejemplo: Si su API La clave es abc123, codificarlo a Base64 y usar Authorization: Basic YWJjMTIz

Carga útil​

Ejemplo básico (configuración predeterminada):

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

Ejemplo avanzado (con todas las opciones):

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

Ejemplo de artículo académico:

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

Ejemplos de código​

El PDF4me Actualizar tabla de contenido REST API Proporciona ejemplos de código en varios lenguajes de programación. Elija el lenguaje que mejor se adapte a su entorno de desarrollo:

C# (CSharp) Muestra

Completo C# Implementación para actualizar la tabla de contenido en documentos de Word:

Casos de uso y aplicaciones en la industria​

Casos de uso de servicios legales y profesionales

  • Navegación de contratos: Crear tabla de contenido detallada para contratos complejos
  • Informes legalesGenerar una estructura navegable para documentos judiciales.
  • Manuales de cumplimiento: Requisitos y procedimientos reglamentarios del índice
  • Documentación del casoOrganizar las pruebas y los argumentos legales.

Obtén ayuda​

Get Your API KeyAPI SamplesGetting Started