División de documentos API
PDF4me Documento dividido Le permite dividir documentos de Word en varios documentos más pequeños con opciones de división flexibles y un control de configuración integral. API El servicio procesa archivos de Word y los divide por páginas, secciones, encabezados o rangos de páginas personalizados con control total sobre los criterios de división, la nomenclatura del documento y la organización de la salida. 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 división por páginas, división por secciones, separación por encabezados y rangos de páginas personalizados, esta solución es ideal para la gestión de documentos, la distribución de contenido y la automatización de 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
- Múltiples tipos de división: Dividir por páginas, secciones, encabezados o rangos personalizados
- Soporte para rangos de páginas: División basada en números de página o rangos específicos
- División basada en secciones: Dividir el documento después de cada sección de Word
- División basada en encabezados: Divide el documento después de cada encabezado del estilo especificado (por ejemplo, Encabezado 1, Encabezado 2).
- Configuración flexible: Criterios de división personalizados con el parámetro splitConfig
- Nombres de documentos únicosCada documento dividido obtiene un nombre de archivo GUID único.
- Preservación del formatoMantiene el formato y la estructura originales del documento.
- Apoyo culturalProcesamiento de documentos específico de la configuración regional
REST API Punto final
El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de división de documentos se realizan a través de un único punto final:
- Método: POST
- Punto final:
office/ApiV2Word/SplitDocument
REST API Parámetros
Lista completa de parámetros para la función Dividir documento 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.
splitConfigEl parámetro es necesario cuandosplitTypees "array", "numberofpages" o "headings".
Parámetros requeridos
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| documento* | Object | Referencia del documento. Debe contener Nombre (string): Nombre del archivo de Word con extensión .docx. Se utiliza para referencia y procesamiento. | { "Name": "document.docx" } |
| docContent* | Base64 | Contenido del documento de Word codificado en Base64El documento se divide según criterios específicos. Debe ser un documento de Word válido (formatos .docx o .doc). | base64EncodedDocumentContent |
Parámetros opcionales
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| tipo dividido | String | Tipo de división de documentos. Opciones: allpages - Dividir en páginas individuales (predeterminado), array - Dividir por rangos de páginas explícitos (por ejemplo, "1-3,4,5-7"), numberofpages - Dividir después de cada N páginas (configuración: número entero positivo como "3" o "5"), section - Divida el documento después de cada sección, headings - Divide el documento después de cada encabezado del estilo dado (por ejemplo, "Encabezado 1"). Cada documento dividido obtiene un identificador único. GUID Nombre del archivo | "allpages" |
| Configuración dividida | String | Configuración para la división. Para la matriz: Rangos de páginas como "1-3,4,5-7" (páginas 1-3, página 4, páginas 5-7) o páginas individuales "1,3,5". Para numberofpages: Un número entero positivo como "3" o "5": se divide después de cada N páginas. Para encabezadosNombre del estilo de encabezado, como "Encabezado 1" o "Encabezado 2". Obligatorio cuando splitType es "array", "numberofpages" o "headings". Los números de página comienzan en 1. La coincidencia de encabezados no distingue entre mayúsculas y minúsculas. | "1-3,4,5-7" o "3" o "Heading 1" |
| Nombre de la cultura | String | Código cultural para el procesamiento de documentos (p. ej., "en-US", "de-DE", "fr-FR"). Valor predeterminado: "en-US". Afecta al idioma y formato del documento. Se utiliza para la gestión de metadatos y localización. | en-US |
Opciones de tipo dividido
El API Ofrece diferentes tipos de división para la segmentación de documentos:
| Tipo dividido | Descripción | Requiere splitConfig | Caso de uso |
|---|---|---|---|
| allpages | Dividir en páginas individuales (predeterminado) | No | Extraiga cada página como un documento independiente. |
| array | Dividir por rangos de páginas explícitos. Cada rango separado por comas se convierte en un documento (por ejemplo, "1-3,4,5-7" → 3 documentos). | Sí | Cree documentos a partir de rangos de páginas específicos o páginas individuales. |
| numberofpages | Se divide después de cada N páginas. Se divide secuencialmente: cada N páginas forman un documento; el resto es el último documento. | Sí | Dividir en fragmentos de igual tamaño (por ejemplo, cada 3 o 5 páginas). |
| section | Divide el documento después de cada sección de Word. | No | Un documento por sección |
| headings | Divida el documento después de cada encabezado del estilo especificado (por ejemplo, "Encabezado 1"). | Sí | Extraer capítulos o partes por nivel de encabezado |
Ejemplos de configuración dividida
Comprender la configuración de división ayuda a optimizar los flujos de trabajo de división de documentos:
array: rangos de páginas explícitos
"1-3,4,5-7"→ 3 documentos: páginas 1-3, página 4, páginas 5-7"1,3,5"→ 3 documentos: página 1, página 3, página 5"1-5,6-10"→ 2 documentos: páginas 1-5, páginas 6-10
numberofpages: dividir después de cada N páginas
Comportamiento: Se divide secuencialmente después de cada N páginas.
Configuración: Obligatorio, el formato es un único número entero positivo (por ejemplo, "3", "5").
Ejemplos:
- Configuración
"3"En un documento de 10 páginas → 4 documentos: Documento 1: páginas 1-3, Documento 2: páginas 4-6, Documento 3: páginas 7-9, Documento 4: página 10 - Configuración
"5"En un documento de 12 páginas → 3 documentos: Documento 1: páginas 1-5, Documento 2: páginas 6-10, Documento 3: páginas 11-12
headings: dividir después de cada encabezado
"Heading 1", un documento por bloque que termina en el siguiente encabezado 1 (o final del documento)"Heading 2", un documento por bloque que termina en el siguiente encabezado 2 (o final del documento)- Coincidencia que no distingue entre mayúsculas y minúsculas
section
No se requiere configuración. El documento se divide después de cada salto de sección de Word; cada sección se convierte en un documento independiente.
Producción
El PDF4me Documento dividido REST API devuelve el resultado dividido como JSON. El API Devuelve un único documento en la respuesta (el primer documento dividido), con campos de respuesta estándar.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Procesamiento síncrono (predeterminado)
El API procesa la solicitud y devuelve el primer documento dividido:
Código de estado: 200 OK
Tipo de contenido: application/json
Cuerpo de la respuesta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx",
"success": true,
"errorMessage": null
}
Campos de respuesta:
- documento (string): El primer contenido del documento dividido, codificado como Base64 cadena
- Nombre del archivo (string): Nombre de archivo generado para el documento dividido (GUID-basado)
- é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:
- Extraer el
documentcampo del JSON respuesta (Base64) - Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
- Utilice el
fileNamepara guardar el documento dividido
Ejemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save with data.fileName or custom name
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) - Configuración de división no válida proporcionada
Configuración divididaes necesario cuandotipo divididoes "matriz", "número de páginas" o "encabezados"- Inválido Base64 codificación en
docContent - Documento de Word no válido o dañado
- No se encontraron encabezados en el documento (para la división basada en encabezados).
- Se ha especificado un rango de páginas no válido (el número de páginas excede el número total de páginas del documento).
- Tipo de divisió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
- Error al dividir el documento
- Error al cargar el documento desde bytes
- Error al convertir el documento a bytes
Formato de respuesta de error:
{
"error": "Error message describing what went wrong"
}
Detalles del formato de respuesta
Importante: El API siempre regresa JSON con una serie de documentos, nunca datos binarios de Word directamente.
Estructura de respuesta:
{
"document": "string", // Base64-encoded Word document content (first split)
"fileName": "string", // GUID-based filename (e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx")
"success": true,
"errorMessage": "string or null"
}
Encabezado de tipo de contenido:
- Éxito:
application/json - El documento dividido 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
// Save with response.fileName or custom name
Python:
import base64
response_data = response.json()
word_bytes = base64.b64decode(response_data['document'])
filename = response_data['fileName']
with open(filename, 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, 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 (Dividir todas las páginas - Predeterminado):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "allpages"
}
Ejemplo de rango de páginas (matriz):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "array",
"splitConfig": "1-3,4,5-7"
}
Ejemplo de división después de cada N páginas (número de páginas):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "numberofpages",
"splitConfig": "3"
}
Ejemplo basado en encabezados (dividido después de cada encabezado):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "headings",
"splitConfig": "Heading 1",
"cultureName": "en-US"
}
Ejemplo basado en secciones (dividido después de cada sección):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "section",
"cultureName": "en-US"
}
Ejemplos de código
El PDF4me Documento dividido 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
- Gestión de contratos: Dividir los contratos multipartitos en secciones individuales
- Documentación del casoExtraer páginas específicas de los expedientes de casos
- Informes de cumplimiento: Distribuir las secciones pertinentes a los diferentes departamentos.
- Investigación jurídica: Dividir documentos legales extensos por tema o sección.
Casos de uso para empresas y negocios
- Distribución de informes: Dividir los informes por secciones para diferentes partes interesadas
- Gestión de propuestas: Extraer secciones para entregables específicos del cliente
- Documentación interna: Dividir los manuales por tema o departamento
- Organización de archivo: Crear fragmentos lógicos de documentos para su almacenamiento y recuperación.
Casos de uso en educación e investigación
- Materiales curriculares: Dividir los libros de texto en capítulos individuales
- Registros estudiantiles: Extraer páginas específicas para diferentes departamentos académicos
- Artículos de investigación: Dividir los artículos extensos por secciones para la revisión por pares.
- Documentación médica y de investigación: Dividir los documentos de investigación o clínicos por metodología o sección.
Casos de uso en finanzas y banca
- Informes financieros: Distribuir secciones específicas a diferentes partes interesadas
- Documentación de auditoríaExtraer las páginas relevantes para las diferentes áreas de auditoría.
- Cumplimiento normativo: Dividir los documentos de cumplimiento por tipo de regulación
- Evaluación de riesgos: Distribuir las secciones de riesgo a los equipos apropiados