Cómo redactar texto en PDF con IronSecureDoc
En este artículo, discutiremos cómo redactar texto en un PDF usando IronSecureDoc. Esto permite que el servicio o proceso censure rápidamente y con facilidad información sensible haciendo una sencilla solicitud POST con el PDF al servidor de IronSecureDoc en funcionamiento. Demostraremos esto visualmente mediante el uso de documentos Swagger. La solicitud POST acepta tanto parámetros obligatorios como opcionales y es altamente personalizable. la respuesta devuelve el PDF con el texto redactado.
Cómo redactar texto en PDF con IronSecureDoc
- Extraer y comenzar la Imagen Docker de IronSecureDoc
- Prueba la API usando Swagger
- Especifique el texto que debe ser redactado.
- Ejecute la llamada API con los detalles proporcionados.
- Exportar el documento PDF redactado
Extraer y Iniciar IronSecureDoc
Si aún no tienes IronSecureDoc en funcionamiento, sigue los enlaces a continuación para configurarlo:
| Alojar localmente | Desplegar en la nube |
|---|---|
La API [POST] Redact Text
El punto final de la API [POST] Redact Text 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. Al usar esta API, puede garantizar que el texto específico se elimine permanentemente, proporcionando una mayor seguridad y asegurando el cumplimiento con los estándares de protección de datos.
Atención
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 redactar texto con Swagger
Acceder a la interfaz de Swagger:
Si su servidor API está ejecutándose localmente, puede acceder a Swagger navegando a http://localhost:8080/swagger/index.html en su navegador web.
Localizar la API [POST] Redactar Texto:
Dentro de Swagger UI, encuentra el endpoint [POST] /v1/document-services/pdfs/redact-text.
Especificar configuraciones:
En este ejemplo, estoy proporcionando tanto el archivo PDF como las palabras a redactar en la solicitud POST. Vamos a redactar la palabra "nosotros" y superponer un cuadro negro sobre ella. Para esta demostración, utilizaremos el archivo 'sample.pdf' con las siguientes configuraciones:
- draw_black_box: true
- coincidir_palabra_completa: verdadero
- palabras_a_redactar: nosotros
Suba un PDF de muestra:
En el cuerpo de la solicitud, suba un archivo PDF de muestra al que desea aplicar la censura. Asegúrese de que el archivo se agregue como archivo_pdf.
Ejecutar la solicitud:
Haga clic en "Ejecutar" para realizar la solicitud. La respuesta incluirá el PDF redactado. Esta interacción de Swagger UI te permite probar fácilmente el proceso de redacción, proporcionando retroalimentación inmediata.
Comprender el resultado
Ejecutamos la solicitud POST después de introducir los parámetros requeridos en el Documento Swagger. Si tiene éxito, la solicitud devuelve un código de estado 200 con un archivo PDF modificado que se puede descargar, como se muestra en el ejemplo anterior.
El PDF modificado arriba muestra áreas donde aparece la palabra 'we' y se reemplaza con un cuadro negro. Además, el booleano match_whole_word está configurado en True, lo que indica que solo censuramos palabras completas y no coincidencias parciales dentro de las palabras.
-->
Usar solicitud CURL a través del Símbolo del sistema
Alternativamente, podemos usar el Símbolo del sistema con una solicitud POST de curl 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 'pdf_file=@sample.pdf;type=application/pdf' \
-F 'words_to_redact="we"' \
-F 'draw_black_box=true' \
-F 'match_whole_word=true'Atención
curl.exe --versionParámetros obligatorios del cuerpo de la solicitud
| Name | Data Type | Description |
|---|---|---|
| pdf_file | application/pdf | The PDF file you want to manipulate. |
| words_to_redact | array[string] | This parameter takes a list of words and redacts the text matching the input. |
Parámetros opcionales del cuerpo de la solicitud
| Name | Data Type | Description |
|---|---|---|
| user_password | string | This is required if the input PDF has a user password. The operation will fail if no password is provided for the password-protected PDF. |
| owner_password | string | This is required if the input PDF has an owner password. The operation will fail if no password is provided for the password-protected PDF. |
| specific_pages | array[int] | Allows you to specify which pages to redact text on. By default, the value is null, meaning the provided word in all the pages will be redacted. |
| draw_black_box | boolean | Allows you to specify whether to draw a black box over the redacted text. By default, this value is set to True. |
| match_whole_word | boolean | Specifies whether partial matches within words should also be redacted. For example, if the provided word is "are," any words containing "are," such as "hare," will have the "are" redacted as well. By default, this is set to True. |
| match_case | boolean | Specifies whether the provided word should be an exact match in terms of case. By default, this value is null. Note: Setting this to True means that lowercase and uppercase strings will not be matched. For example, if the provided word is "WE," the lowercase version "we" would not be redacted. |
| overlay_text | string | It specifies the overlay text, such as words or symbols, over the redacted text. By default, this string is empty. |
| save_as_pdfa | boolean | Saves the modified PDF with PDF/A-3 compliance. By default, this is set to False. |
| save_as_pdfua | boolean | Saves the modified PDF with PDF/UA compliance. By default, this is set to False. |
Parámetros de encabezado opcionales
| Name | Data Type | Description |
|---|---|---|
| author | string | Useful for identifying you as the author of the PDF document. By default, this field is empty. |
| title | string | Displays the title of the PDF document. By default, this field is empty. |
| subject | string | Useful for identifying the content of the PDF document at a glance. By default, this field is empty. |
