Cómo redactar regiones en archivos PDF

This article was translated from English: Does it need improvement?
Translated
View the article in English

por Mehr Muhammad Hamza

La redacción de información sensible en documentos PDF es crucial para garantizar la privacidad y el cumplimiento de las regulaciones de protección de datos. En[POST]La Redact Region API de IronSecureDoc ofrece una forma eficiente de ocultar texto e información sensible en regiones específicas de un documento PDF utilizando un verdadero redacción. Esta API asegura que los datos redactados se eliminen por completo y no puedan recuperarse, lo que la hace ideal para manejar información confidencial en documentos legales, financieros o personales.

Extraer y Iniciar IronSecureDoc

Si aún no tienes IronSecureDoc en funcionamiento, sigue los enlaces a continuación para configurarlo:

Acoger localmenteDespliegue en la nube

La API [POST]Región de Redacción

En[POST]El punto final de la API de Redact Region permite ocultar información sensible en regiones específicas de un documento PDF mediante una verdadera redacción. Esta función es crucial para las aplicaciones que gestionan documentos confidenciales, como contratos legales, registros médicos o estados financieros. Al aprovechar esta API, puedes asegurar que el texto sensible dentro de las áreas definidas de un PDF sea eliminado permanentemente, ofreciendo tanto seguridad como cumplimiento.

Atención
Una vez que una región es redactada, el contenido dentro de esa área no puede ser recuperado.

Probarlo en Swagger

Swagger es una herramienta poderosa que permite a los desarrolladores interactuar con APIs RESTful a través de una interfaz web amigable. Ya sea que estés usando lenguajes como Python, Java u otros, Swagger ofrece una manera conveniente de probar e implementar esta API.

Pasos para redaccionar región con Swagger

  1. Acceder a Swagger UI:

    Si su servidor API está ejecutándose localmente, puede acceder a Swagger navegando a http://localhost:8080/swagger/index.html en su navegador web.

    Documentación de Swagger

  2. Ubique el [POST]API de Redact Region:**

    Dentro de la interfaz de usuario de Swagger, encuentra el [POST]/v1/document-services/pdfs/redact-region endpoint.

    Redactar regiones

  3. Especificar Coordenadas de Redacción:

    En este ejemplo, eliminaremos una tabla del PDF en la página con índice 1(Es decir, Página n.º 2). Utilice las siguientes coordenadas para definir la región de redacción:

    • Índice de la página(páginas_específicas): 1
    • Coordenada X(región_a_redactar_x): 60
    • Coordenada Y(region_to_redact_y): 270
    • Ancho(región_a_redactar_w): 470
    • Altura(región_a_redactar_h): 200
  4. Establecer parámetros opcionales:

    Opcionalmente, puedes agregar una contraseña de usuario o propietario, especificar páginas concretas o decidir si dibujar un recuadro negro sobre el área redactada y guardar el documento con cumplimiento PDF/A o PDF/UA.

    Entrada Swagger

  5. Sube un PDF de muestra:

    En el cuerpo de la solicitud, suba un archivo PDF de muestra al que desea aplicar la censura. Asegúrate de que el archivo se agregue como pdf_file.

  6. Ejecutar la solicitud:

    Haz clic en "Ejecutar" para ejecutar la solicitud. La respuesta incluirá el PDF redactado, con la tabla eliminada del índice de página 1 según lo especificado.

    Respuesta

    Esta interacción con Swagger UI te permite probar fácilmente el proceso de redacción, proporcionando retroalimentación inmediata sobre cómo las coordenadas afectan el contenido del PDF.

  7. Verifique el PDF de salida:

    La región redactada estará en la página 2.


Comprender los parámetros de entrada

Antes de usar esta API, es esencial comprender los parámetros de entrada requeridos y opcionales para redactar una región en su PDF. Estos parámetros ayudan a definir el área específica a redactar.

Parámetros clave

  • pdf_file: El documento PDF que deseas redactar.
  • region_to_redact_x: Coordenada X de la región a redactar(comenzando desde la esquina inferior izquierda de la página).
  • region_to_redact_y: Coordenada Y de la región a redactar(comenzando desde la esquina inferior izquierda de la página).
  • region_to_redact_w: Ancho de la región a redactar.
  • region_to_redact_h: Altura de la región a redactar.

Parámetros opcionales

  • user_password: Si el PDF está protegido con contraseña, proporcione la contraseña del usuario.
  • owner_password: Proporcione la contraseña del propietario si las modificaciones están restringidas.
  • specific_pages: Especifica qué páginas redactar. Si no se proporciona, la redacción se aplica a todas las páginas.
  • save_as_pdfa: Guardar el PDF con cumplimiento PDF/A-3.
  • save_as_pdfua: Guarda el PDF con cumplimiento de PDF/UA.

Integración de API: Ejemplo en Python

Una vez que esté familiarizado con los parámetros, puede llamar a esta API utilizando su lenguaje de programación preferido. A continuación se muestra un ejemplo de cómo integrar esta API utilizando Python.

import requests

url = 'http://localhost:8080/v1/document-services/pdfs/redact-region'
headers = {
    'accept': '*/*',
    'author': 'IronSoftware',
    'title': 'REDACT REGION DEMO 2024',
    'subject': 'DEMO EXAMPLE'
}

# Open the file
files = {
    'pdf_file': ('sample_file.pdf', open('sample_file.pdf', 'rb'), 'application/pdf')
}

# Prepare the argument
data = {
    'region_to_redact_x': '60',
    'region_to_redact_y': '270',
    'region_to_redact_w': '470',
    'region_to_redact_h': '200',
    'specific_pages':[1]
}

# Call the API
response = requests.post(url, headers=headers, files=files, data=data)

# Save the redacted PDF
with open('redacted_output.pdf', 'wb') as f:
    f.write(response.content)

print('PDF redacted successfully.')
PYTHON

Este código realiza los siguientes pasos:

  • Cargar el PDF: El archivo PDF que se va a redactar se carga desde el sistema de archivos local.
  • Establecer Parámetros de Redacción: Especifique las coordenadas(X, Y)ancho, alto y página específica para editar.
  • Llamar a la API: El [POST]Se llama a la Redact Region API, pasando los parámetros necesarios.
  • Guardar el resultado: El PDF redactado se guarda como un nuevo archivo.

    La región indicada está redactada como se muestra a continuación.

    Salida redactada