Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Atualizar Sumário - TOC Gerenciamento API

PDF4me Atualizar Sumário Permite atualizar ou criar sumários em documentos do Word com opções abrangentes de formatação e recursos de estilo profissional. API O serviço processa arquivos do Word e gera TOCcom detecção automática de existentes TOC campos, níveis de cabeçalho personalizáveis, suporte a hiperlinks, controle de espaçamento entre tabulações, opções de maiúsculas e minúsculas e localização de idioma. O API recebe conteúdo de documento Word através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com controle total sobre TOC Em termos de aparência e funcionalidade, esta solução é ideal para navegação em documentos, formatação profissional e automação. TOC fluxos de trabalho de geração.

Artigos relacionados no blogue
Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.
Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.
Visite o blogue →

Autenticando seu API Solicitar​

Para acessar o PDF4me REST APIPara que uma solicitação seja aceita, é necessário incluir as credenciais de autenticação adequadas. A autenticação garante a segurança da comunicação e valida sua identidade como usuário autorizado do sistema. REST API.

Get your api Key

Principais características​

  • Automático TOC DetecçãoLocaliza e atualiza registros existentes. TOC campos ou cria novos
  • Níveis de título personalizáveis: Controlar quais níveis de cabeçalho incluir (1-6)
  • Suporte a hiperlinksAtivar ou desativar links clicáveis no TOC
  • Controle do líder da guiaMostrar ou ocultar pontos entre o texto e os números de página.
  • Opções de maiúsculas e minúsculas no textoUse letras maiúsculas ou mantenha o formato original.
  • Localização CulturalSuporte para diferentes idiomas e regiões.
  • Formatação profissionalAplicação automática de profissionais TOC estilo
  • Integração de números de páginaCálculo e atualização automáticos do número de páginas

REST API Ponto final​

O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de atualização do sumário são realizadas por meio de um único ponto de extremidade:

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

REST API Parâmetros​

Lista completa de parâmetros para a atualização do sumário. REST APIOs parâmetros estão organizados por categoria para melhor compreensão e implementação.

Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios. Os parâmetros avançados fornecem controle preciso sobre TOC formatação e aparência.

Parâmetros obrigatórios​

ParâmetroTipoDescriçãoExemplo
documento*ObjectReferência do documento. Deve conter Nome (string): Nome do arquivo do Word com extensão .docx{ "Name": "document.docx" }
conteúdo do documento*Base64Conteúdo do documento Word codificado em Base64. TOC é gerado a partir dos cabeçalhos deste documento. Deve ser um documento Word válido (formatos .docx, .doc).UEsDBBQABgAIAAAA...

Parâmetros opcionais​

ParâmetroTipoDescriçãoExemplo
níveis de cabeçalhoStringNíveis de cabeçalho a incluir em TOCFormato de intervalo: "1-3" (inclui os níveis de título 1, 2 e 3). Nível único: "1". Vários intervalos: "1-2, 4-6". Padrão: "1-3". Mapeia para os estilos de título integrados do Word. Analisa o documento em busca de títulos existentes. TOC campos. Cria novos TOC no início do documento, se nenhum existir."1-3"
usarHiperlinksBooleanInclua hiperlinks no Sumário. true = TOC As entradas são links clicáveis (padrão), false = texto simplestrue
ocultarLíder da guiaBooleanOcultar pontos de guia de tabulação. true = Sem pontos entre o texto e os números de página (padrão), false = Pontos entre o texto e os números de páginatrue
useMaiúsculasBooleanUse letras maiúsculas para TOC entradas. true = TOC entradas em maiúsculas (padrão), false = caso originaltrue
nome_da_culturaStringCódigo de cultura para processamento de documentos (ex.: "en-US", "de-DE", "fr-FR"). Padrão: nulo. Afeta o idioma e a formatação do documento.en-US

TOC Comportamento de geração​

  • Existente TOC DetecçãoDigitaliza o documento em busca de informações existentes. TOC campos (FieldType.FieldTOC) e os atualiza
  • Novo TOC CriaçãoSe não TOC existe, cria novo TOC no início do documento
  • Mapeamento de níveis de cabeçalho: Mapeia para os estilos de título integrados do Word (Título 1, Título 2, etc.)
  • Atualizações de campoAtualiza os campos várias vezes para garantir a precisão.
  • Layout da páginaChama UpdateFields() e UpdatePageLayout() em sequência.

Saída​

O PDF4me Atualizar Sumário REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna o documento Word como um Base64string codificada em JSON formato, não como dados binários.

Processamento síncrono (padrão)

O API processa a solicitação e retorna:

Código de status: 200 OK

Tipo de conteúdo: application/json

Corpo da resposta:

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

Campos de resposta:

  • documento (string): O documento do Word com o sumário atualizado, codificado como Base64 corda
  • nome_do_arquivo (string): O nome do arquivo Word de saída
  • sucesso (boolean): Indica se a solicitação foi bem-sucedida
  • mensagem de erro (string ou nulo): Detalhes do erro quando o sucesso for falso

Como usar:

  1. Extraia o document campo do JSON resposta (Base64)
  2. Decifre o Base64 string para obter os dados binários do documento Word
  3. Salve ou processe o arquivo do Word conforme necessário.

Exemplo (JavaScript):

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

Exemplo de solicitação​

Cabeçalho​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Observação:

  • Adquira o seu API chave do PDF4me Painel
  • O API a chave deve ser Base64 codificado e prefixado com "Básico" no Authorization cabeçalho
  • Exemplo: Se o seu API chave é abc123, codifique-o para Base64 e usar Authorization: Basic YWJjMTIz

Carga útil​

Exemplo básico (configurações padrão):

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

Exemplo avançado (com todas as opções):

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

Exemplo de artigo acadêmico:

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

Exemplos de código​

O PDF4me Atualizar Sumário REST API Fornece exemplos de código em várias linguagens de programação. Escolha a linguagem que melhor se adapta ao seu ambiente de desenvolvimento:

C# (CSharp) Amostra

Completo C# Implementação para atualização do sumário em documentos do Word:

Casos de uso e aplicações industriais​

Casos de uso de serviços jurídicos e profissionais

  • Navegação de ContratosCriar sumário detalhado para contratos complexos.
  • Resumos JurídicosGerar estrutura navegável para documentos judiciais
  • Manuais de ConformidadeRequisitos e procedimentos regulamentares do índice
  • Documentação do casoOrganizar provas e argumentos jurídicos

Obtenha ajuda​

Get Your API KeyAPI SamplesGetting Started