API Redact PDF
Supprimer définitivement le texte, les pixels d'image et le contenu vectoriel superposé des rectangles de page explicitement sélectionnés.
Sémantique du point de terminaison et de la tâche#
Code d'opération : redact
Commencez cette opération avec POST /v1/tasks et le code d'outil affiché ci-dessus. Importez et joignez les PDF source (ou utilisez les points de terminaison d'importation limités à la tâche), puis appelez POST /v1/tasks/{task_id}/process avec les paramètres d'opération.
Préparez les documents examinés pour la divulgation avec les zones de contenu sensible connues.
Entrées : Exactement un PDF scellé ; 1–200 rectangles explicites, chacun à l'intérieur de sa page cible.
Configuration et paramètres supplémentaires#
| Paramètre | Tapez | Comportement |
|---|---|---|
| regionsobligatoire | object[] | Chaque région : {page,x0,y0,x1,y1}, la page commence à 1 et les coordonnées du rectangle utilisent les points PDF à partir du coin supérieur gauche de la page. Tous les rectangles doivent être dans les limites de la page. |
| strip_metadata | boolean | Supprimez également les métadonnées, les pièces jointes et les scripts. Par défaut : true. |
Les options sont validées par l'API. Les paramètres inconnus et les valeurs non prises en charge retournent une erreur au lieu d'être ignorés.
Séquence de demande en cours#
Programming language: cURL
Choisir une langue · faites défiler horizontalement pour les 10 langages SDK
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"tool":"redact"}'
# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'
# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"options":{"regions":[{"page":1,"x0":72,"y0":100,"x1":300,"y1":132}],"strip_metadata":true}}'
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_API_KEY'After starting a task, upload and verify PDFs, review the credit quote, and get explicit approval before processing. API keys belong on your server, never on signed storage uploads.
Les packages téléchargeables générés couvrent uniquement le flux de travail des tâches. Les SDK de service complet nécessitent une spécification OpenAPI de runtime vérifiée ; les SDK de tâches Python, JavaScript et TypeScript diffusent les importations de fichiers ; les autres langues nécessitent des importations multipart signées implémentées par l'appelant.
L'ID de tâche retourné est utilisé à la fois pour l'interrogation du statut et la récupération. Une fois la tâche réussie, demandez une URL de sortie signée plutôt que d'intégrer un secret de téléchargement.
Résultat et détails importants#
Nouveau PDF avec contenu physiquement supprimé dans les régions marquées et remplissage noir appliqué.
Nécessite un examen visuel et une vérification par rapport à l'original. N'est pas un détecteur de rédaction sémantique ; ne garantit pas que toutes les instances d'un nom ailleurs dans un fichier sont trouvées. Les objets vectoriels qui se chevauchent peuvent être supprimés en totalité. Les pages cibles doivent être non pivotées et les PDF avec des champs de formulaire doivent d'abord être aplatis. Les signatures numériques existantes sont invalidées.
Erreurs, tentatives et facturation