Comment rédiger du texte sur PDF avec IronSecureDoc
Dans cet article, nous allons discuter de la rédaction de texte sur un PDF en utilisant IronSecureDoc. Cela permet au service ou au processus de masquer rapidement et facilement les informations sensibles en envoyant une simple requête POST avec le PDF au serveur IronSecureDoc en cours d'exécution. Nous allons le démontrer visuellement à l'aide des documents Swagger. La requête POST accepte à la fois des paramètres obligatoires et optionnels et est hautement personnalisable ; la réponse renvoie le PDF avec le texte caviardé.
Comment rédiger du texte sur PDF avec IronSecureDoc
- Extraire et démarrer l'image Docker IronSecureDoc
- Tester l'API avec Swagger
- Spécifier le texte à rédiger
- Exécutez l'appel API avec les détails fournis
- Exporter le document PDF caviardé
Extraire et démarrer IronSecureDoc
Si vous n'avez pas encore IronSecureDoc en cours d'exécution, veuillez suivre les liens ci-dessous pour l'installer :
| Host Locally | Deploy to Cloud |
|---|---|
L'API [POST] Redact Text
L'endpoint API [POST] Redact Text vous permet de masquer du texte sensible dans un document PDF en utilisant la rédaction. Cette fonctionnalité est essentielle pour les applications qui traitent des documents confidentiels, tels que des contrats juridiques, des dossiers médicaux ou des rapports financiers. En utilisant cette API, vous pouvez vous assurer que le texte spécifié est définitivement supprimé, offrant une sécurité accrue et garantissant la conformité aux normes de protection des données.
A noter
Swagger
Swagger est un outil puissant qui permet aux développeurs d'interagir avec des API RESTful via une interface web conviviale. Que vous utilisiez des langages comme Python, Java ou d'autres, Swagger offre un moyen pratique de tester et d'implémenter cette API.
Étapes pour rédiger du texte avec Swagger
Accéder à l'interface Swagger :
Si votre serveur API fonctionne localement, vous pouvez accéder à Swagger en naviguant vers http://localhost:8080/swagger/index.html dans votre navigateur web.
Localiser l'API de caviardage de texte [POST] :
Dans l'interface Swagger, trouvez le point de terminaison [POST] /v1/document-services/pdfs/redact-text.
Spécifier les configurations :
Dans cet exemple, je fournis à la fois le fichier PDF et les mots à censurer dans la requête POST. Nous allons censurer le mot "nous" et superposer un encadré noir dessus. Pour cette démonstration, nous utiliserons le fichier 'sample.pdf' avec les configurations suivantes :
- draw_black_box: true
- correspondance_mot_entier: vrai
- mots_à_supprimer: nous
Téléchargez un exemple de PDF :
Dans le corps de la requête, téléchargez un fichier PDF d'exemple sur lequel vous souhaitez appliquer la caviardage. Assurez-vous que le fichier est ajouté en tant que pdf_file.
Exécuter la demande :
Cliquez sur "Exécuter" pour lancer la requête. La réponse inclura le PDF expurgé. Cette interaction avec Swagger UI vous permet de tester facilement le processus de rédaction, fournissant un retour immédiat.
Comprendre le résultat
Nous exécutons la requête POST après avoir saisi les paramètres requis dans le document Swagger. Si elle réussit, la requête renvoie un code status 200 avec un fichier PDF modifié qui peut être téléchargé, comme indiqué dans l'exemple ci-dessus.
Le PDF modifié ci-dessus montre les zones où le mot 'nous' apparaît et est remplacé par un carré noir. De plus, le booléen match_whole_word est défini sur True, indiquant que nous ne caviardons que les mots entiers et non les correspondances partielles au sein des mots.
-->
Utiliser une requête CURL via l'invite de commande
Alternativement, nous pouvons utiliser le Command Prompt avec une requête POST curl pour obtenir le même résultat.
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'Par défaut, PowerShell peut interpréter curl comme un alias pour Invoke-WebRequest, un cmdlet intégré de PowerShell. Essayez d'utiliser curl.exe au lieu de curl.
curl.exe --version)}]
Paramètres requis du corps de la requête
| 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. |
Paramètres optionnels du corps de la requête
| 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. |
Paramètres d'en-tête facultatifs
| 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. |
