How to Redact Text in C# PDF with IronSecureDoc
Dans cet article, nous aborderons la rédaction de texte dans un PDF à l'aide d'IronSecureDoc. Cela permet au service ou au processus de masquer rapidement et facilement les informations sensibles en effectuant une simple requête POST avec le PDF vers le serveur IronSecureDoc en cours d'exécution. Nous allons le démontrer visuellement à l'aide de la documentation Swagger. La requête POST accepte à la fois des paramètres obligatoires et facultatifs et est hautement personnalisable ; La réponse renvoie le PDF contenant le texte expurgé.
Comment masquer du texte dans un PDF avec IronSecureDoc
- Téléchargez et démarrez l'image Docker IronSecureDoc.
- Testez l'API en utilisant Swagger
- Spécifiez le texte à expurger
- Exécutez l'appel API avec les détails fournis
- Exportez le document PDF expurgé
Démarrez IronSecureDoc
Si IronSecureDoc n'est pas encore installé, veuillez suivre les liens ci-dessous pour le configurer :
| Hébergez localement | Déploiement sur le cloud |
|---|---|
L'API de rédaction de texte [POST]
Le point de terminaison [POST] de l'API Redact Text vous permet de masquer du texte sensible dans un document PDF à l'aide de 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. L'utilisation de cette API garantit la suppression définitive de textes spécifiques, ce qui renforce la sécurité et assure la conformité aux normes de protection des données.
Fanfaronnade
Swagger est un outil puissant qui permet aux développeurs d'interagir avec les API RESTful via une interface web conviviale. Que vous utilisiez des langages comme Python, Java ou autres, Swagger offre un moyen pratique de tester et d'implémenter cette API.
Étapes pour masquer du texte avec Swagger
-
Accédez à l'interface utilisateur Swagger :
Si votre serveur API s'exécute en local, vous pouvez accéder à Swagger en vous rendant sur
http://localhost:8080/swagger/index.htmldans votre navigateur web.
-
Localisez l'API [POST] Redact Text :
Dans l'interface utilisateur Swagger, recherchez 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 à masquer dans la requête
POST. Nous allons masquer le mot " we " et y superposer un carré noir. Pour cette démonstration, nous utiliserons le fichier " sample.pdf " avec les configurations suivantes :draw_black_box:truematch_whole_word:truewords_to_redact: nous
-
Téléversez un exemple de PDF :
Dans le corps de la requête, veuillez télécharger un exemple de fichier PDF où vous souhaitez appliquer la rédaction. Assurez-vous que le fichier est ajouté sous la forme
pdf_file. - Exécuter la requête :
Cliquez sur "Exécuter" pour exécuter la requête. La réponse inclura le PDF expurgé. Cette interaction Swagger UI vous permet de tester facilement le processus de rédaction, en fournissant un retour d'information immédiat.
Utiliser une requête CURL via l'invite de commandes
Sinon, nous pouvons utiliser l'invite de commande avec une requête curl POST 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'
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'
curl comme un alias de Invoke-WebRequest, une cmdlet PowerShell intégrée. Essayez d'utiliser curl.exe à la place de curl.
curl.exe --version
curl.exe --version
)}]
Paramètres obligatoires du corps de la requête
| Nom | Type de données | Description du projet |
|---|---|---|
fichier_pdf |
application/pdf |
Le fichier PDF que vous souhaitez manipuler. |
mots_à_rédiger |
array[string] |
Ce paramètre prend une liste de mots et supprime le texte correspondant à l'entrée. |
Paramètres facultatifs du corps de la requête
| Nom | Type de données | Description du projet |
|---|---|---|
mot_de_passe |
chaîne |
Cette étape est nécessaire si le fichier PDF d'entrée est protégé par un mot de passe utilisateur. L'opération échouera si aucun mot de passe n'est fourni pour le fichier PDF protégé. |
mot_de_passe_propriétaire |
chaîne |
Cette étape est nécessaire si le fichier PDF d'entrée est protégé par un mot de passe. L'opération échouera si aucun mot de passe n'est fourni pour le fichier PDF protégé. |
pages_spécifiques |
array[int] |
Vous permet de spécifier sur quelles pages réduire le texte. Par défaut, la valeur est null, ce qui signifie que le mot fourni sera réduit sur toutes les pages. |
draw_black_box |
booléen |
Vous permet de spécifier s'il faut dessiner une boîte noire sur le texte réduit. Par défaut, cette valeur est définie sur True. |
match_complet |
booléen |
Spécifie si des correspondances partielles au sein des mots doivent également être réduites. Par exemple, si le mot fourni est " sont ", tous les mots contenant " sont ", comme " paroles ", auront également le " sont " réduit. Par défaut, ceci est défini sur True. |
match_case |
booléen |
Spécifie si le mot fourni doit être une correspondance exacte en termes de casse. Par défaut, cette valeur est null. Remarque : Définir cela sur True signifie que les chaînes minuscules et majuscules ne seront pas appariées. Par exemple, si le mot fourni est " NOUS ", la version en minuscule " nous " ne serait pas réduite. |
overlay_text |
chaîne |
Il spécifie le texte de superposition, comme des mots ou des symboles, sur le texte expurgé. Par défaut, cette chaîne est vide. |
save_as_pdfa |
booléen |
Enregistre le PDF modifié avec conformité PDF/A-3. Par défaut, ceci est défini sur False. |
save_as_pdfua |
booléen |
Enregistre le PDF modifié avec conformité PDF/UA. Par défaut, ceci est défini sur False. |
Paramètres d'en-tête optionnels
| Nom | Type de données | Description du projet |
|---|---|---|
auteur |
chaîne |
Ce champ permet de vous identifier comme auteur du document PDF. Par défaut, il est vide. |
titre |
chaîne |
Affiche le titre du document PDF. Par défaut, ce champ est vide. |
sujet |
chaîne |
Permet d'identifier rapidement le contenu d'un document PDF. Par défaut, ce champ est vide. |
Questions Fréquemment Posées
Comment puis-je expurger du texte dans un PDF en utilisant une requête POST ?
Vous pouvez expurger du texte dans un PDF en effectuant une requête POST au serveur IronSecureDoc avec le fichier PDF et les mots que vous souhaitez expurger. Le serveur traite la requête et renvoie un PDF avec le texte expurgé.
Quelles sont les étapes pour utiliser l'API d'IronSecureDoc pour l'expurgation de PDF ?
Pour utiliser l'API d'IronSecureDoc pour l'expurgation de PDF, vous devez d'abord télécharger et démarrer l'image Docker IronSecureDoc, tester l'API en utilisant Swagger, spécifier le texte à expurger, exécuter l'appel API, et enfin exporter le document PDF expurgé.
Comment puis-je tester l'API d'IronSecureDoc avant de l'utiliser en production ?
Vous pouvez tester l'API d'IronSecureDoc en utilisant Swagger en accédant à Swagger UI, qui vous permet d'utiliser les points de terminaison fournis pour simuler le processus d'expurgation.
Quels paramètres peuvent être personnalisés dans une requête d'expurgation de PDF ?
Dans une requête d'expurgation de PDF, vous pouvez personnaliser des paramètres tels que user_password, owner_password, specific_pages, draw_black_box, match_whole_word, match_case, overlay_text, save_as_pdfa, et save_as_pdfua pour une personnalisation plus poussée.
Comment puis-je exécuter une requête d'expurgation de PDF en utilisant curl ?
Pour exécuter une requête d'expurgation de PDF en utilisant curl, vous pouvez utiliser une commande POST de curl, en spécifiant les paramètres nécessaires et le chemin du fichier dans votre invite de commande.
Que dois-je faire si mon PDF est protégé par mot de passe lors de l'expurgation ?
Si votre PDF est protégé par mot de passe, vous devez inclure le user_password ou owner_password dans les paramètres optionnels pour vous assurer que le processus d'expurgation puisse accéder et modifier le document.
Quel est l'objectif du paramètre 'draw_black_box' dans l'expurgation de texte ?
Le paramètre 'draw_black_box' spécifie s'il faut couvrir le texte expurgé avec une boîte noire. Cette option est utile pour visualiser les zones expurgées et est activée par défaut.
Comment puis-je héberger IronSecureDoc localement à des fins d'expurgation ?
Vous pouvez héberger IronSecureDoc localement en suivant les tutoriels fournis pour divers systèmes d'exploitation comme Windows, Mac ou Linux, vous permettant de gérer le processus d'expurgation sur votre serveur local.
Est-il possible d'expurger des pages spécifiques dans un PDF ?
Oui, vous pouvez spécifier quelles pages expurger en utilisant le paramètre 'specific_pages', ce qui vous permet de cibler des zones particulières du document pour l'expurgation.
Puis-je superposer du texte sur les zones expurgées dans un PDF ?
Oui, vous pouvez superposer du texte sur les zones expurgées en utilisant le paramètre 'overlay_text', qui vous permet de remplacer le texte expurgé par un message ou un indicatif personnalisé.
IronSecureDoc est-il compatible avec .NET 10 et ses bibliothèques clientes ?
Oui, IronSecureDoc propose un client .NET via le package NuGet Iron Software.SecureDoc.Client, compatible avec .NET 10 ainsi qu'avec les versions précédentes (.NET 6 à 9). Vous pouvez ainsi intégrer facilement la rédaction et les API associées dans vos applications .NET 10.

