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

Extrair metadados de documentos do Word - Análise de documentos API

PDF4me Extrair metadados do Word Permite extrair metadados e propriedades abrangentes de documentos do Word com recursos detalhados de análise de documentos. API O serviço processa arquivos do Word e recupera propriedades de documentos integradas, propriedades personalizadas, estatísticas do documento, informações do autor, datas de criação e controle de revisões. API recebe conteúdo de documento Word através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para formatação e localização específicas de cada cultura, esta solução é ideal para gerenciamento de documentos, rastreamento de conformidade, análise de conteúdo e fluxos de trabalho de documentos corporativos.

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​

  • Extração abrangente de metadadosRecuperar todas as propriedades de documento integradas e personalizadas
  • Estatísticas do documentoObtenha a contagem de páginas, palavras, caracteres e parágrafos em tempo real.
  • Informações sobre o autorExtrair informações sobre o autor, gerente, empresa e contato.
  • Propriedades de data/horaRecuperar registros de data e hora de criação, modificação e impressão.
  • Propriedades personalizadasAcesse todas as propriedades personalizadas do documento com prefixo automático.
  • Apoio à CulturaFormatar datas e horas de acordo com a localidade especificada.
  • Operação somente leituraExtrair metadados sem modificar o documento original.
  • Saída EstruturadaRetornar metadados organizados em JSON formato para facilitar o processamento

REST API Ponto final​

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

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

REST API Parâmetros​

Lista completa de parâmetros para a função Extrair Metadados do Word 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 e devem ser fornecidos para o API para funcionar corretamente.

Parâmetros obrigatórios​

ParâmetroTipoDescriçãoExemplo
documento*ObjectReferência do documento. Deve conter Nome (string): Nome do arquivo Word com extensão .docx{ "Name": "document.docx" }
conteúdo do documento*Base64Conteúdo do documento Word codificado em Base64UEsDBBQABgAIAAAA...

Parâmetros opcionais​

ParâmetroTipoDescriçãoExemplo
nome_da_culturaStringCódigo de cultura para formatação de data/hora (por exemplo, "en-US", "de-DE", "fr-FR"). Padrão: InvariantCulture (formatação consistente). Afeta o formato de exibição de data/hora nos metadados. Culturas inválidas utilizam o padrão InvariantCulture.en-US

Saída​

O PDF4me Extrair metadados do Word REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna os metadados como um JSON objeto, 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": null,
"fileName": null,
"success": true,
"errorMessage": null,
"metadata": {
"Author": "John Doe",
"Title": "Project Proposal",
"Subject": "Q1 2024 Planning",
"Keywords": "planning, budget, strategy",
"Comments": "Draft version for review",
"Category": "Business",
"Company": "Acme Corporation",
"Manager": "Jane Smith",
"Created": "1/15/2024 10:30:00 AM",
"LastModified": "1/20/2024 2:45:00 PM",
"LastPrinted": "1/18/2024 9:15:00 AM",
"RevisionNumber": 3,
"TotalEditingTime": 120,
"Pages": 8,
"Words": 2150,
"Characters": 12800,
"Paragraphs": 45,
"Custom_Department": "Marketing",
"Custom_ProjectCode": "PRJ-2024-001",
"Custom_Confidential": "Internal"
}
}

Campos de resposta:

  • documento (Base64 ou nulo): Não utilizado para extração de metadados; pode ser nulo
  • nome_do_arquivo (string ou nulo): Não utilizado para extração de metadados; pode ser nulo
  • sucesso (booleano): Indica se a solicitação foi bem-sucedida.
  • mensagem de erro (string ou nulo): Detalhes do erro quando o sucesso for falso
  • metadados (objeto): Dicionário de metadados abrangente contendo todas as propriedades do documento

Como usar:

  1. Extraia o metadata campo do JSON resposta
  2. Aceda às propriedades individuais conforme necessário.
  3. Utilize metadados para classificação de documentos, rastreamento de conformidade ou análise.

Exemplo (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const author = data.metadata.Author;
const pageCount = data.metadata.Pages;
// Access any metadata property

Propriedades dos metadados​

Propriedades de documento integradas​

Nome da propriedadeTipoDescriçãoExemplo
AutorStringNome do autor do documento"John Doe"
TítuloStringTítulo do documento"Project Proposal"
AssuntoStringAssunto do documento"Q1 2024 Planning"
Palavras-chaveStringPalavras-chave do documento (separadas por vírgulas)"planning, budget, strategy"
ComentáriosStringComentários do documento"Draft version for review"
CategoriaStringCategoria do documento"Business"
EmpresaStringNome da empresa"Acme Corporation"
GerenteStringNome do gerente"Jane Smith"
CriadoStringData/hora de criação do documento (formatada)"1/15/2024 10:30:00 AM"
Última modificaçãoStringÚltima data/hora salva (formatada)"1/20/2024 2:45:00 PM"
Última impressãoStringÚltima data/hora impressa (formatada)"1/18/2024 9:15:00 AM"
Número da revisãoIntegerNúmero da revisão do documento3
Tempo total de ediçãoIntegerTempo total de edição em minutos120

Estatísticas do documento​

Nome da propriedadeTipoDescriçãoExemplo
PáginasIntegerNúmero total de páginas8
PalavrasIntegerContagem total de palavras2150
PersonagensIntegerContagem total de caracteres12800
ParágrafosIntegerNúmero total de parágrafos45

Propriedades personalizadas​

As propriedades personalizadas são prefixadas com Custom_ na resposta:

  • Custom_Department - Propriedade do departamento alfandegário
  • Custom_ProjectCode - Propriedade de código de projeto personalizado
  • Custom_Confidential - Nível de confidencialidade personalizado
  • Quaisquer outras propriedades personalizadas definidas no documento do Word.

Exemplos de cultura apoiada​

Código de CulturaDescriçãoExemplo de formato de data
en-USInglês (Estados Unidos)"15/01/2024 10:30:00"
en-GBInglês (Reino Unido)"15/01/2024 10:30:00"
de-DEAlemão (Alemanha)"15.01.2024 10:30:00"
fr-FRFrancês (França)"15/01/2024 10:30:00"
es-ESEspanhol (Espanha)"15/01/2024 10:30:00"
ja-JPJaponês (Japão)"2024/01/15 10:30:00"

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 (somente campos obrigatórios):

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

Exemplo avançado (com campos opcionais):

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "cultureName": "en-US"
}

Exemplos de código​

O PDF4me Extrair metadados do Word 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) Exemplo

Completo C# Implementação para extrair metadados do Word:

Casos de uso e aplicações industriais​

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

  • Classificação de DocumentosClassificar documentos jurídicos por tipo de caso, cliente ou área de atuação.
  • Rastreamento de ConformidadeMonitorar as datas de criação e o histórico de revisões dos documentos para fins de conformidade regulatória.
  • Gestão de Documentos do ClienteRastrear propriedades de documentos para organização de arquivos do cliente
  • Manutenção do Registro de AuditoriaRegistrar metadados de documentos para fins de auditoria legal.

Obtenha ajuda​

Get Your API KeyAPI SamplesGetting Started