Otimizar Documento - Otimização de Documentos API
PDF4me Otimizar documento Permite otimizar documentos do Word em termos de tamanho e desempenho com três níveis diferentes de compressão e técnicas abrangentes de otimização. API O serviço processa arquivos do Word, reduzindo seu tamanho, comprimindo imagens, limpando o conteúdo, normalizando a formatação e removendo informações pessoais. API recebe conteúdo de documento Word através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para níveis de otimização Baixo, Médio e Alto, que permitem redução de 0 a 90% no tamanho dos arquivos, esta solução é ideal para fluxos de trabalho de preparação de documentos, otimização de armazenamento e melhoria de desempenho.
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.
Principais características
- Otimização máximaPerfil de compressão máxima para máxima redução do tamanho do arquivo
- Redução do tamanho do arquivoObtenha uma redução de 80 a 90% no tamanho dos arquivos com a otimização máxima.
- Compressão de ImagensOtimização inteligente de imagens com preservação da qualidade.
- Limpeza de conteúdoRemover macros não utilizadas, comentários e conteúdo oculto.
- Normalização de formataçãoLimpar formatação redundante e estilos não utilizados
- Remoção de informações pessoaisRemover informações sobre autor, gerente e empresa
- Otimização de fontesNormalizar fontes e remover propriedades de fonte desnecessárias.
- Melhoria de compatibilidadeOtimizar documentos para compatibilidade com o Word 2016
REST API Ponto final
O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de otimização de documentos são realizadas por meio de um único ponto de extremidade:
- Método: POST
- Ponto final:
office/ApiV2Word/OptimizeDocument
REST API Parâmetros
Lista completa de parâmetros para a função Otimizar Documento 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. O nível de otimização determina a agressividade das técnicas de otimização aplicadas.
Parâmetros obrigatórios
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| documento* | Object | Referência do documento. Deve conter Nome (string): Nome do arquivo Word com extensão .docx | { "Name": "document.docx" } |
| conteúdo do documento* | Base64 | Conteúdo do documento Word codificado em Base64O documento original não foi modificado - uma nova versão otimizada foi criada. | UEsDBBQABgAIAAAA... |
Parâmetros opcionais
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| nível de otimização | String | Nível de otimização (ex.: Baixo, Médio, Máximo). Máximo - Compressão máxima (~80-90%). Controla a agressividade das técnicas de otimização. | "Max" |
| Versão em Word | String | Versão do Word de destino para compatibilidade | null |
| nome_da_cultura | String | Código de cultura para processamento de documentos (por exemplo, "en-US", "de-DE", "fr-FR") | en-US |
Perfil de Otimização
O Máximo O perfil de otimização proporciona compressão máxima:
- Redução do tamanho do arquivo80-90%
- Qualidade da imagemOtimizado para tamanho
- FormataçãoLimpeza agressiva
- Comentários: Removido
- Revisões: Removido
- Informações pessoais: Removido
- Macros: Removido
- Estilos não utilizados: Removido
- Conteúdo oculto: Removido
Saída
O PDF4me Otimizar documento 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.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
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 Word otimizado com tamanho de arquivo reduzido, codificado como Base64 corda
- nome_do_arquivo (string): O nome do arquivo Word de saída
- sucesso (booleano): Indica se a solicitação foi bem-sucedida.
- mensagem de erro (string ou nulo): Detalhes do erro quando o sucesso for falso
Como usar:
- Extraia o
documentcampo do JSON resposta (Base64) - Decifre o Base64 string para obter os dados binários do documento Word
- 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
Processamento assíncrono
Comportamento assíncrono (202 Accepted (com polling) é controlado pela configuração do servidor, não por um parâmetro no corpo da requisição. Quando habilitado, o API pode retornar um status 202 com uma pesquisa URL no Location cabeçalho. Consulte o URL com GET Faça solicitações até receber 200. OK com o mesmo formato de resposta (documento, nome do arquivo, sucesso, mensagem de erro).
Respostas de erro
O API retorna padrão HTTP Códigos de erro com detalhes do erro:
- Parâmetros de solicitação inválidos
- Campos obrigatórios ausentes (
documentocomNome,conteúdo do documento) - Inválido Base64 codificação em
conteúdo do documento - Documento do Word inválido ou corrompido
- Nível de otimização inválido
- Inválido ou ausente API chave
- API chave não está corretamente Base64 codificado em Authorization cabeçalho
- Ausente
Autorização: Básicacabeçalho
- Erro de processamento no servidor
- falha no processamento do documento Word
- Falha na otimização do documento
- Erro ao aplicar as configurações de compressão
Formato da resposta de erro:
{
"error": "Error message describing what went wrong"
}
Detalhes do formato da resposta
Importante: O API sempre retorna JSON, nunca dados binários do Word diretamente.
Estrutura da resposta:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
Cabeçalho Content-Type:
- Sucesso:
application/json - O documento do Word está incorporado como um Base64 string dentro do JSON resposta
Por que Base64?
- JSON-Codificação segura para dados binários
- Fácil de transmitir HTTP
- Compatível com todas as linguagens de programação.
- Pode ser incorporado diretamente em JSON sem escapar dos problemas
Decodificando Base64 Para documento do Word:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.docx", 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 usarAuthorization: Basic YWJjMTIz
Carga útil
Exemplo básico (otimização máxima padrão):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max"
}
Exemplo avançado (com campos opcionais):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max",
"wordVersion": null,
"cultureName": "en-US"
}
Exemplos de código
O PDF4me Otimizar documento 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Amostra
Java Implementação com tratamento completo de erros e processamento de respostas:
JavaScript Amostra
Node.js e compatível com navegadores JavaScript Implementação:
Google Script Amostra
Google Apps Script implementação para Google Workspace integração:
Casos de uso e aplicações industriais
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casos de uso de serviços jurídicos e profissionais
- Distribuição de DocumentosOtimizar documentos jurídicos para distribuição ao cliente.
- Arquivamento públicoPreparar documentos para apresentação em tribunais públicos
- Armazenamento de ArquivosOtimizar documentos jurídicos para armazenamento a longo prazo
- Documentos de ConformidadeLimpar documentos para submissão a órgãos reguladores
Casos de uso para empresas e negócios
- Distribuição da propostaOtimizar propostas para entrega ao cliente.
- Compartilhamento de material de marketingOtimizar documentos de marketing para distribuição pública.
- Otimização de ApresentaçãoOtimizar apresentações para distribuição por e-mail
- Preparação de entregáveis para o clienteLimpar e organizar os documentos para entrega ao cliente.
Casos de uso em educação e pesquisa
- Distribuição de Relatórios de PacientesOtimize relatórios médicos para compartilhamento seguro.
- Documentação de pesquisaOtimizar documentos de pesquisa para publicação.
- Compartilhamento de protocolosOtimizar protocolos médicos para distribuição no departamento.
- Documentação de ConformidadeLimpar documentos para submissão a órgãos reguladores
Casos de uso em finanças e bancos
- Distribuição do Relatório FinanceiroOtimizar relatórios financeiros para distribuição às partes interessadas.
- Documentação de auditoriaLimpar os documentos de auditoria para compartilhamento externo.
- Compartilhamento de documentos orçamentáriosOtimizar documentos orçamentários para distribuição departamental.
- Arquivamento regulatórioPreparar documentos para submissões regulatórias