PDF redigeren API
Verwijder permanent tekst, afbeeldingspixels en overlappende vectorinhoud uit expliciet geselecteerde paginarechthoeken.
Eindpunt- en taaksemantiek#
Bewerkingscode: redact
Start deze bewerking met POST /v1/tasks en de hierboven weergegeven toolcode. Upload en voeg bron-PDF's toe (of gebruik taakgerelateerde upload-eindpunten), vervolgens roep aan POST /v1/tasks/{task_id}/process met bewerkingsinstellingen.
Bereid beoordeelde documenten voor openbaarmaking voor met bekende gevoelige inhoudsgebieden.
Invoer: Exact één verzegelde PDF; 1–200 expliciete rechthoeken, elk binnen de doelpagina.
Configuratie en extra parameters#
| Instelling | Typ | Gedrag |
|---|---|---|
| regionsverplicht | object[] | Elke regio: {page,x0,y0,x1,y1}, pagina begint bij 1 en rechthoekcoördinaten gebruiken PDF-punten vanaf de linkerbovenhoek van de pagina. Alle rechthoeken moeten binnen de paginagrenzen liggen. |
| strip_metadata | boolean | Verwijder ook metagegevens, bijlagen en scripts. Standaard: true. |
Opties worden gevalideerd door de API. Onbekende instellingen en niet-ondersteunde waarden retourneren een fout in plaats van te worden genegeerd.
Werkende aanvraagvolgorde#
Programming language: cURL
Kies een taal · scroll horizontaal voor alle 10 SDK-talen
# 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.
Gegenereerde downloadbare pakketten dekken alleen de taakwerkstroom. Full-service SDK's vereisen een geverifieerde runtime OpenAPI-specificatie; de Python-, JavaScript- en TypeScript-taak-SDK's streamen bestandsuploads; de andere talen vereisen ondertekende multipart-uploads geïmplementeerd door de aanroeper.
De geretourneerde taak-ID wordt gebruikt voor zowel statuspolling als ophalen. Nadat de taak is voltooid, vraagt u een ondertekende uitvoer-URL aan in plaats van een downloadgeheim in te sluiten.
Uitvoer en belangrijke details#
Nieuwe PDF met inhoud fysiek verwijderd in gemarkeerde regio's en zwarte vulling toegepast.
Vereist visuele controle en verificatie tegen origineel. Geen semantische redactiedetector; garandeert niet dat alle instanties van een naam elders in een bestand worden gevonden. Kruisende vectorobjecten kunnen volledig worden verwijderd. Doelpagina's moeten niet-geroteerd zijn en PDF's met formuliervelden moeten eerst worden afgevlakt. Bestaande digitale handtekeningen worden ongeldig gemaakt.
Fouten, nieuwe pogingen en facturering