Optimizar documento - Optimización de documentos API
PDF4me Optimizar documento Te permite optimizar documentos de Word en cuanto a tamaño y rendimiento con tres niveles de compresión diferentes y técnicas de optimización integrales. API El servicio procesa archivos de Word y reduce el tamaño de los archivos, comprime imágenes, limpia el contenido, normaliza el formato y elimina la información personal. API recibe el contenido del documento de Word a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Con soporte para niveles de optimización Bajo, Medio y Alto, que permiten una reducción del tamaño de los archivos de entre el 0 % y el 90 %, esta solución es ideal para la preparación de documentos, la optimización del almacenamiento y la mejora del rendimiento en los flujos de trabajo.
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.
Características principales
- Optimización máximaPerfil de compresión máximo para una máxima reducción del tamaño del archivo.
- Reducción del tamaño del archivo: Logre una reducción del tamaño de archivo del 80-90% con la optimización máxima.
- Compresión de imágenesOptimización inteligente de imágenes con preservación de la calidad.
- Limpieza de contenido: Eliminar macros, comentarios y contenido oculto no utilizados
- Normalización de formato: Limpiar el formato redundante y los estilos no utilizados.
- Eliminación de información personalEliminar información del autor, el gerente y la empresa.
- Optimización de fuentesNormalizar las fuentes y eliminar las propiedades de fuente innecesarias.
- Mejora de la compatibilidadOptimizar documentos para la compatibilidad con Word 2016
REST API Punto final
El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de optimización de documentos se realizan a través de un único punto final:
- Método: POST
- Punto final:
office/ApiV2Word/OptimizeDocument
REST API Parámetros
Lista completa de parámetros para el documento Optimizar 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. El nivel de optimización determina la agresividad de las técnicas de optimización aplicadas.
Parámetros requeridos
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| documento* | Object | Referencia del documento. Debe contener Nombre (cadena): Nombre del archivo de Word con extensión .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Contenido del documento de Word codificado en Base64El documento original no se ha modificado; se ha creado una nueva versión optimizada. | UEsDBBQABgAIAAAA... |
Parámetros opcionales
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| Nivel de optimización | String | Nivel de optimización (p. ej., Bajo, Medio, Máximo). Máximo - Compresión máxima (~80-90%). Controla la agresividad de las técnicas de optimización. | "Max" |
| versión de Word | String | Versión de Word de destino para compatibilidad | null |
| Nombre de la cultura | String | Código cultural para el procesamiento de documentos (por ejemplo, "en-US", "de-DE", "fr-FR") | en-US |
Perfil de optimización
El Máximo El perfil de optimización proporciona la máxima compresión:
- Reducción del tamaño del archivo: 80-90%
- Calidad de imagen: Optimizado para tamaño
- FormatoLimpieza agresiva
- Comentarios: Eliminado
- Revisiones: Eliminado
- Información personal: Eliminado
- Macros: Eliminado
- Estilos no utilizados: Eliminado
- Contenido oculto: Eliminado
Producción
El PDF4me Optimizar documento 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.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
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 (cadena): El documento de Word optimizado con tamaño de archivo reducido, codificado como Base64 cadena
- Nombre del archivo (cadena): El nombre del archivo Word de salida
- éxito (booleano): Indica si la solicitud se realizó correctamente.
- mensaje de error (cadena o nulo): Detalles del error cuando el éxito es falso.
Cómo usarlo:
- Extraer el
documentcampo del JSON respuesta (Base64) - Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
- 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
Procesamiento asíncrono
Comportamiento asíncrono (202 Accepted con sondeo) se controla mediante la configuración del servidor, no mediante un parámetro del cuerpo de la solicitud. Cuando está habilitado, el API puede devolver un estado 202 con una encuesta URL en el Location encabezado. Sondear el URL con GET solicitudes hasta que reciba 200 OK con la misma estructura de respuesta (documento, nombre de archivo, éxito, mensaje de error).
Respuestas de error
El API devuelve estándar HTTP Códigos de error con detalles del error:
- Parámetros de solicitud no válidos
- Faltan campos obligatorios (
documentoconNombre,docContent) - Inválido Base64 codificación en
docContent - Documento de Word no válido o dañado
- Nivel de optimización no válido
- Inválido o faltante API llave
- API La llave no funciona correctamente. Base64 codificado en Authorization encabezado
- Desaparecido
Autorización: Básicaencabezado
- Error de procesamiento del servidor
- Error en el procesamiento del documento de Word
- Fallo en la optimización del documento
- Error al aplicar la configuración de compresión.
Formato de respuesta de error:
{
"error": "Error message describing what went wrong"
}
Detalles del formato de respuesta
Importante: El API siempre regresa JSON, nunca datos binarios de Word directamente.
Estructura de respuesta:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
Encabezado de tipo de contenido:
- Éxito:
application/json - El documento de Word está incrustado como un Base64 cadena dentro de la JSON respuesta
Por qué Base64¿
- JSON-Codificación segura para datos binarios
- Fácil de transmitir HTTP
- Compatible con todos los lenguajes de programación.
- Se puede integrar directamente en JSON sin escapar de los problemas
Decodificación Base64 al documento de 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);
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 usarAuthorization: Basic YWJjMTIz
Carga útil
Ejemplo básico (optimización máxima predeterminada):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max"
}
Ejemplo avanzado (con campos opcionales):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max",
"wordVersion": null,
"cultureName": "en-US"
}
Ejemplos de código
El PDF4me Optimizar documento 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Muestra
Java Implementación con manejo completo de errores y procesamiento de respuestas:
JavaScript Muestra
Node.js y compatible con navegadores JavaScript implementación:
Google Script Muestra
Google Apps Script implementación para Google Workspace integración:
Casos de uso y aplicaciones en la industria
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casos de uso de servicios legales y profesionales
- Distribución de documentosOptimizar los documentos legales para su distribución a los clientes.
- Presentación pública: Preparar documentos para su presentación pública ante los tribunales.
- Almacenamiento de archivosOptimizar los documentos legales para su almacenamiento a largo plazo.
- Documentos de cumplimiento: Limpiar los documentos para las presentaciones regulatorias
Casos de uso para empresas y negocios
- Distribución de propuestasOptimizar las propuestas para su entrega al cliente.
- Compartir material de marketingOptimizar los documentos de marketing para su distribución pública.
- Optimización de presentacionesOptimizar las presentaciones para su distribución por correo electrónico.
- Preparación de los entregables para el cliente: Limpiar los documentos para su entrega al cliente
Casos de uso en educación e investigación
- Distribución de informes de pacientesOptimizar los informes médicos para compartirlos de forma segura.
- Documentación de investigaciónOptimizar los documentos de investigación para su publicación.
- Compartir protocolosOptimizar los protocolos médicos para su distribución departamental.
- Documentación de cumplimiento: Limpiar los documentos para las presentaciones regulatorias
Casos de uso en finanzas y banca
- Distribución de informes financierosOptimizar los informes financieros para su distribución entre las partes interesadas.
- Documentación de auditoría: Limpiar los documentos de auditoría para compartirlos externamente
- Compartir documentos presupuestariosOptimizar los documentos presupuestarios para su distribución departamental.
- Presentación de documentos regulatorios: Preparar documentos para presentaciones regulatorias