Documento seguro - Seguridad de los documentos API

PDF4me Documento seguro Le permite agregar protección con contraseña y restricciones de seguridad a los documentos de Word con controles de seguridad integrales y restricciones de edición. API El servicio procesa archivos de Word y aplica protección de contraseña abierta, restricciones de edición de documentos, protección de solo lectura, acceso solo para comentarios, edición de campos de formulario y seguimiento de revisiones. 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 control total sobre los niveles de seguridad y los requisitos de contraseña, esta solución es ideal para documentos confidenciales, edición colaborativa y flujos de trabajo de control de acceso a documentos.

Entradas de blog relacionadas

Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.

Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.

Visita el blog →

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.

Get your api Key

Características principales

• Protección con contraseña: Agregar requisitos de contraseña para abrir documentos
• Protección de documentos: Restringir las capacidades de edición con varios tipos de protección.
• Seguridad de solo lectura: Hacer que los documentos sean de solo lectura para evitar ediciones no autorizadas.
• Acceso solo para comentarios: Permitir únicamente la adición o modificación de comentarios.
• Edición de campos de formularioRestringir la edición únicamente a los campos del formulario.
• Seguimiento de revisiones: Permitir únicamente cambios y revisiones registrados
• Seguridad combinadaAplicar protección mediante contraseña y restricciones de edición.
• Control de acceso flexible: Diferentes niveles de seguridad para diferentes casos de uso

REST API Punto final

El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de seguridad de documentos se realizan a través de un único punto final:

• Método: POST
• Punto final: office/ApiV2Word/ApplySecurity

REST API Parámetros

Lista completa de parámetros para el documento seguro 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. Los parámetros de contraseña son obligatorios cuando se activan las opciones de seguridad correspondientes.

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	{ "Name": "document.docx" }
docContent*	Base64	Contenido del documento de Word codificado en Base64Se han aplicado ajustes de seguridad a este documento. Debe ser un documento de Word válido (formatos .docx o .doc).	base64EncodedDocumentContent

Parámetros opcionales (Configuración de seguridad)

Parámetro	Tipo	Descripción	Ejemplo
seguroAlAbrir	String	Habilite la protección con contraseña para abrir el documento. "yes" = Requiere contraseña para abrir, "no" = No se requiere contraseña para abrir (predeterminado). Requiere contraseña segura al abrir cuando está habilitado	"yes"
contraseña segura al abrir	String	Se requiere contraseña para abrir el documento. Obligatorio cuando secureOnOpen es "yes"Debe ser una contraseña segura (8 o más caracteres). Distingue entre mayúsculas y minúsculas.	"SecurePass123!"
opciones de seguridad	Object	Opciones de protección de documentos. Propiedades: tipo de protección (string: NoProtection, ReadOnly, AllowComments, AllowFormFields, AllowRevisions), contraseña de protección (string). Obligatorio cuando protectionType no es "NoProtection"	{ "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" }

Opciones de tipo de protección

El API Ofrece diferentes tipos de protección para las restricciones de edición de documentos:

Tipo de protección	Descripción	Caso de uso
NoProtection	Sin restricciones de edición (predeterminado)	Documentos que pueden editarse libremente
ReadOnly	El documento no se puede editar, solo visualizar.	Documentos finales, informes publicados
AllowComments	Solo se pueden añadir/modificar comentarios.	Flujos de trabajo de revisión de documentos
AllowFormFields	Solo se pueden editar los campos del formulario.	Formularios rellenables, encuestas
AllowRevisions	Solo se permiten cambios/revisiones registrados.	Edición colaborativa con seguimiento de cambios

Configuración de seguridad

Protección con contraseña (Abrir contraseña)

• Objetivo: Se requiere contraseña para abrir el documento.
• Cuándo usarDocumentos confidenciales, información sensible
• Requisito: secureOnOpenPassword debe proporcionarse cuando secureOnOpen es "yes"
• Fortaleza: Se recomienda un máximo de 8 caracteres, incluyendo caracteres alfanuméricos y especiales.

Protección de documentos (restricciones de edición)

• ObjetivoRestringe las capacidades de edición, pero permite la visualización del documento.
• Cuándo usarEdición colaborativa, distribución de formularios, flujos de trabajo de revisión
• Requisito: securityOptions.protectionPassword debe proporcionarse cuando securityOptions.protectionType no es "Sin protección"
• Flexibilidad: Se puede combinar con contraseña abierta para una seguridad de doble capa.

Producción

El PDF4me Documento seguro 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

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 (string): El documento de Word con la configuración de seguridad aplicada, codificado como Base64 cadena
• Nombre del archivo (string): El nombre del archivo de Word de salida
• é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:

1. Extraer el document campo del JSON respuesta (Base64)
2. Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
3. Guarde o procese el archivo de Word según sea necesario.
4. El documento requerirá contraseña(s) al abrirse en Word según la configuración de seguridad.

Ejemplo (JavaScript):

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

Asynchronous Processing

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).

Error Responses

Respuestas de error

El API devuelve estándar HTTP Códigos de error con detalles del error:

400 Bad Request

• Parámetros de solicitud no válidos
• Faltan campos obligatorios (documento con Nombre, docContent)
• Se requiere contraseña cuando seguroAlAbrir es "sí" (contraseña segura al abrir)
• Se requiere contraseña de protección en opciones de seguridad cuando protectionType no es "NoProtection"
• Inválido Base64 codificación en docContent
• Documento de Word no válido o dañado
• Tipo de protección no válido
• Contraseña débil (se recomienda menos de 8 caracteres)

401 Unauthorized

• Inválido o faltante API llave
• API La llave no funciona correctamente. Base64 codificado en Authorization encabezado
• Desaparecido Autorización: Básica encabezado

500 Internal Server Error

• Error de procesamiento del servidor
• Error en el procesamiento del documento de Word
• Error al aplicar la configuración de seguridad.
• Error al cargar el documento desde bytes

Formato de respuesta de error:

{
"error": "Error message describing what went wrong"
}

Response Format Details

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 with security applied
"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 usar Authorization: Basic YWJjMTIz

Carga útil

Ejemplo básico (solo protección con contraseña):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!"
}

Ejemplo avanzado (contraseña + protección de solo lectura):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!",
 "securityOptions": {
 "protectionType": "ReadOnly",
 "protectionPassword": "EditPass456!"
 }
}

Ejemplo de protección solo para comentarios:

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowComments",
 "protectionPassword": "ReviewPass789!"
 }
}

Ejemplo de protección de campos de formulario:

{
 "document": { "Name": "form.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowFormFields",
 "protectionPassword": "FormPass2024!"
 }
}

Ejemplos de código

El PDF4me Documento seguro 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#

C# (CSharp) Muestra

Completo C# Implementación para proteger documentos de Word:

View C# Sample

Java

Java Muestra

Java Implementación con manejo completo de errores y procesamiento de respuestas:

View Java Sample

JavaScript

JavaScript Muestra

Node.js y compatible con navegadores JavaScript implementación:

View JavaScript Sample

Python

Python Muestra

Python implementación con la biblioteca requests y JSON manejo:

View Python Sample

Salesforce

Salesforce Muestra

Salesforce Apex implementación para CRM integración:

View Salesforce Sample

n8n

n8n Muestra

n8n Implementación de flujos de trabajo para la automatización:

View n8n Sample

Google Script

Google Script Muestra

Google Apps Script implementación para Google Workspace integración:

View Google Script Sample

AWS Lambda

AWS Lambda Muestra

Sin servidor AWS Lambda Implementación de la función:

View AWS Lambda Sample

Casos de uso y aplicaciones en la industria

Legal & Professional Services

Casos de uso de servicios legales y profesionales

• Documentos confidenciales del clienteAplicar protección mediante contraseña a documentos legales confidenciales.
• Seguridad contractual: Contratos seguros con protección de solo lectura para revisión por parte del cliente.
• Distribución de formularios legalesAplicar protección de campos de formulario a formularios legales
• Revisión de documentosUtilice la protección de solo comentarios para la revisión de documentos legales.

Business & Enterprise

Casos de uso para empresas y negocios

• Seguridad de la propuestaAplicar protección mediante contraseña a las propuestas confidenciales.
• Revisión de documentos del cliente: Utilice la protección de solo comentarios para la revisión de documentos del cliente.
• Distribución de formularios de marketingAplicar protección de campos de formulario a los formularios de marketing.
• Colaboración en la documentación de ventasUtilice la protección contra revisiones para la edición de documentos de ventas.

Education & Research

Casos de uso en educación e investigación

• Seguridad de los documentos del pacienteAplicar protección con contraseña a los documentos confidenciales de los pacientes.
• Protección de informes médicosInformes médicos seguros con protección de solo lectura.
• Colaboración en la elaboración de documentos de investigaciónUtilice la protección contra revisiones para la edición de documentos de investigación.
• Documentos académicos e institucionales: Proteger los programas de estudio, las subvenciones y los documentos internos.

Finance & Banking

Casos de uso en finanzas y banca

• Informe financiero sobre valoresAplicar protección mediante contraseña a los informes financieros confidenciales.
• Protección de documentos de auditoría: Proteja los documentos de auditoría con protección de solo lectura.
• Distribución del formulario de presupuestoAplicar protección de campos de formulario a los formularios de presupuesto
• Documentación de cumplimientoUtilice la protección contra revisiones para la edición de documentos de cumplimiento.

Obtén ayuda

Get Your API KeyAPI SamplesGetting Started