1. IronSecureDoc
  2. Guías
  3. Redactar Texto

Cómo redactar texto en un PDF de C# con IronSecureDoc

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

En este artículo, discutiremos cómo redactar texto en un PDF usando IronSecureDoc. Esto permite que el servicio o proceso redacte rápidamente y fácilmente información sensible haciendo una simple solicitud POST al servidor de IronSecureDoc en funcionamiento. Demostraremos esto visualmente a través del uso de los documentos Swagger. La solicitud POST toma tanto parámetros requeridos como opcionales y es altamente personalizable; la respuesta devuelve el PDF con el texto redactado.

Cómo redactar texto en PDF con IronSecureDoc

  1. Extraiga e inicie la imagen Docker de IronSecureDoc
  2. Prueba la API usando Swagger
  3. Especifica el texto que se desea redactar
  4. Ejecuta la llamada API con los detalles proporcionados
  5. Exporta el documento PDF redactado

Tire y arranque IronSecureDoc

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

Alojar localmente Implementar en la nube

La API de redacción de texto [POST]

El punto de acceso de la API Redactar Texto [POST] le permite ocultar texto sensible dentro de un documento PDF usando redacción. Esta funcionalidad es esencial para aplicaciones que manejan documentos confidenciales, como contratos legales, registros médicos o informes financieros. Usar esta API garantiza que el texto específico sea eliminado permanentemente, proporcionando mayor seguridad y asegurando el cumplimiento con los estándares de protección de datos.

@@--SOPORTE-i-ABIERTO--@@Una vez que se redacta un texto, el contenido no se puede recuperar.@@--CIERRE DE SOPORTE--@@

Pavonearse

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

Pasos para redactar texto con Swagger

  1. Acceder a la interfaz Swagger:

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

Documentos Swagger

  1. Ubique la API Redactar Texto [POST]:

    Dentro de la interfaz de usuario de Swagger, encuentre el punto de acceso [POST] /v1/document-services/pdfs/redact-text.

Redactar texto

  1. Especifique las configuraciones:

En este ejemplo, estoy proporcionando tanto el archivo PDF como las palabras a redactar en la solicitud POST. Redactaremos la palabra "nosotros" y la superpondremos con una caja negra. Para esta demostración, usaremos el archivo 'sample.pdf' con las siguientes configuraciones:

  • dibujar_caja_negra: true
  • coincidir_palabra_completa: true
  • palabras_para_redactar: nosotros

  1. Suba un PDF de muestra:

    En el cuerpo de la solicitud, cargue un archivo PDF de ejemplo donde desee aplicar la redacción. Asegúrese de que el archivo se agregue como archivo pdf.

  2. Ejecutar la solicitud:

Haga clic en "Ejecutar" para ejecutar la solicitud. La respuesta incluirá el PDF redactado. Esta interacción con la interfaz de usuario de Swagger le permite probar fácilmente el proceso de redacción, proporcionando retroalimentación inmediata.

Utilice la solicitud CURL a través del símbolo del sistema

Alternativamente, podemos usar el símbolo del sistema con una solicitud curl POST para lograr el mismo resultado.

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
 -H 'accept: */*' \
 -H 'Content-Type: multipart/form-data' \
 -F 'archivo pdf=@sample.pdf;type=solicitud/pdf' \
 -F 'palabras_para_redactar="we"' \
 -F 'dibujar_caja_negra=true' \
 -F 'coincidir_palabra_completa=true'
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
 -H 'accept: */*' \
 -H 'Content-Type: multipart/form-data' \
 -F 'archivo pdf=@sample.pdf;type=solicitud/pdf' \
 -F 'palabras_para_redactar="we"' \
 -F 'dibujar_caja_negra=true' \
 -F 'coincidir_palabra_completa=true'
SHELL

@@--SOPORTE-i-ABIERTO--@@ Por defecto, PowerShell puede interpretar curl como un alias para Invoke-WebRequest, un cmdlet integrado de PowerShell. Trate de usar curl.exe en lugar de curl.

curl.exe --version
curl.exe --version
SHELL

@@--CIERRE DE SOPORTE--@@

Parámetros obligatorios del cuerpo de la solicitud

Nombre Tipo de datos Descripción
archivo pdf solicitud/pdf El archivo PDF que desea manipular.
palabras_para_redactar matriz[cadena] Este parámetro toma una lista de palabras y redacta el texto que coincide con la entrada.

Parámetros opcionales del cuerpo de la solicitud

Nombre Tipo de datos Descripción
contraseña de usuario cadena Esto es necesario si el PDF de entrada tiene contraseña de usuario. La operación fallará si no se proporciona una contraseña para el PDF protegido.
contraseña del propietario cadena Esto es necesario si el PDF de entrada tiene una contraseña de propietario. La operación fallará si no se proporciona una contraseña para el PDF protegido.
páginas específicas matriz[int] Permite especificar en qué páginas se eliminará el texto. Por defecto, el valor es nulo, lo que significa que se eliminará la palabra proporcionada en todas las páginas.
dibujar_caja_negra booleano Permite especificar si se dibuja un recuadro negro sobre el texto redactado. Por defecto, este valor es "Verdadero".
coincidir_palabra_completa booleano Especifica si también se deben eliminar las coincidencias parciales dentro de las palabras. Por ejemplo, si la palabra proporcionada es "son", cualquier palabra que contenga "son", como "liebre", también eliminará "son". De forma predeterminada, este valor es "Verdadero".
caso_coincidencia booleano Especifica si la palabra proporcionada debe coincidir exactamente con las mayúsculas y minúsculas. Por defecto, este valor es nulo. Nota: Si se establece en "Verdadero", no se compararán las cadenas en minúsculas y mayúsculas. Por ejemplo, si la palabra proporcionada es "NOSOTROS", la versión en minúsculas "nosotros" no se eliminará.
texto superpuesto cadena Especifica el texto superpuesto, como palabras o símbolos, sobre el texto redactado. Por defecto, esta cadena está vacía.
guardar como pdfa booleano Guarda el PDF modificado conforme a PDF/A-3. Por defecto, está configurado como Falso.
guardar_como_pdfua booleano Guarda el PDF modificado conforme a PDF/UA. Por defecto, está configurado como Falso.

Parámetros de encabezado opcionales

Nombre Tipo de datos Descripción
autor cadena Útil para identificarte como autor del documento PDF. Por defecto, este campo está vacío.
título cadena Muestra el título del documento PDF. Por defecto, este campo está vacío.
sujeto cadena Útil para identificar el contenido del documento PDF a simple vista. Por defecto, este campo está vacío.

Preguntas Frecuentes

¿Cómo puedo redactar texto en un PDF usando una solicitud POST?

Puedes redactar texto en un PDF realizando una solicitud POST al servidor IronSecureDoc con el archivo PDF y las palabras que deseas redactar. El servidor procesa la solicitud y devuelve un PDF con el texto redactado.

¿Cuáles son los pasos para usar la API de IronSecureDoc para la redacción de PDF?

Para usar la API de IronSecureDoc para la redacción de PDF, primero debes descargar y comenzar la imagen de Docker de IronSecureDoc, probar la API usando Swagger, especificar el texto para redactar, ejecutar la llamada API y finalmente exportar el documento PDF redactado.

¿Cómo puedo probar la API de IronSecureDoc antes de usarla en producción?

Puedes probar la API de IronSecureDoc usando Swagger accediendo a la interfaz de Swagger, la cual te permite usar los endpoints proporcionados para simular el proceso de redacción.

¿Qué parámetros pueden personalizarse en una solicitud de redacción de PDF?

En una solicitud de redacción de PDF, puedes personalizar parámetros como user_password, owner_password, specific_pages, draw_black_box, match_whole_word, match_case, overlay_text, save_as_pdfa y save_as_pdfua para una mayor personalización.

¿Cómo ejecuto una solicitud de redacción de PDF usando curl?

Para ejecutar una solicitud de redacción de PDF usando curl, puedes usar un comando de solicitud POST de curl, especificando los parámetros necesarios y la ruta del archivo en tu línea de comandos.

¿Qué debo hacer si mi PDF está protegido con contraseña durante la redacción?

Si tu PDF está protegido con contraseña, necesitas incluir el user_password o owner_password en los parámetros opcionales para asegurar que el proceso de redacción pueda acceder y modificar el documento.

¿Cuál es el propósito del parámetro 'draw_black_box' en la redacción de texto?

El parámetro 'draw_black_box' especifica si se cubre el texto redactado con un cuadro negro. Esta opción es útil para visualizar las áreas redactadas y está habilitada por defecto.

¿Cómo puedo alojar IronSecureDoc localmente para fines de redacción?

Puedes alojar IronSecureDoc localmente siguiendo los tutoriales proporcionados para varios sistemas operativos como Windows, Mac o Linux, permitiéndote gestionar el proceso de redacción en tu servidor local.

¿Es posible redactar páginas específicas en un PDF?

Sí, puedes especificar qué páginas redactar usando el parámetro 'specific_pages', el cual te permite dirigir áreas particulares del documento para la redacción.

¿Puedo superponer texto en áreas redactadas en un PDF?

Sí, puedes superponer texto en áreas redactadas usando el parámetro 'overlay_text', el cual te permite reemplazar el texto redactado con un mensaje personalizado o un marcador de posición.

¿IronSecureDoc es compatible con .NET 10 y sus bibliotecas cliente?

Sí, IronSecureDoc proporciona un cliente .NET a través del paquete NuGet Iron Software.SecureDoc.Client, y es compatible con .NET 10, además de versiones anteriores como .NET 6-9. Esto garantiza la integración fluida de la redacción y las API relacionadas en aplicaciones .NET 10.

Curtis Chau
Curtis Chau
  Chatea con el equipo de ingeniería ahora
Escritor Técnico

Curtis Chau tiene una licenciatura en Ciencias de la Computación (Carleton University) y se especializa en el desarrollo front-end con experiencia en Node.js, TypeScript, JavaScript y React. Apasionado por crear interfaces de usuario intuitivas y estéticamente agradables, disfruta trabajando con frameworks modernos y creando manuales bien ...

Leer más
¿Listo para empezar?
Version: 2024.10 recién lanzado