Zredaguj interfejs API PDF
Trwale usuń tekst, piksele obrazu i nakładającą się zawartość wektorową z wyraźnie wybranych prostokątów strony.
Semantyka punktów końcowych i zadań#
Kod operacji: redact
Rozpocznij tę operację za pomocą POST /v1/tasks oraz kod narzędzia pokazany powyżej. Prześlij i dołącz źródłowe pliki PDF (lub użyj punktów końcowych przesyłania o zakresie zadań), a następnie zadzwoń POST /v1/tasks/{task_id}/process z ustawieniami operacyjnymi.
Przygotuj sprawdzone dokumenty do ujawnienia ze znanymi wrażliwymi obszarami treści.
Wejścia: Dokładnie jeden zapieczętowany plik PDF; 1–200 wyraźnych prostokątów, każdy na stronie docelowej.
Konfiguracja i dodatkowe parametry#
| Ustawienie | Typ | Zachowanie |
|---|---|---|
| regionswymagane | object[] | Każdy region: {page,x0,y0,x1,y1}, strona zaczyna się od 1, a współrzędne prostokąta wykorzystują punkty PDF z lewego górnego rogu strony. Wszystkie prostokąty muszą mieścić się w granicach strony. |
| strip_metadata | boolean | Usuń także metadane, załączniki i skrypty. Domyślnie: true. |
Opcje są sprawdzane przez API. Nieznane ustawienia i nieobsługiwane wartości zwracają błąd zamiast być ignorowane.
Robocza sekwencja żądań#
Programming language: cURL
Wybierz język · przewiń w poziomie, aby zobaczyć wszystkie 10 języków 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.
Wygenerowane pakiety do pobrania obejmują wyłącznie przebieg zadania. Zestawy SDK z pełną obsługą wymagają zweryfikowanej specyfikacji OpenAPI środowiska wykonawczego; przesyłanie strumieniowych plików SDK zadań Python, JavaScript i TypeScript; inne języki wymagają podpisanego przesyłania wieloczęściowego realizowanego przez osobę wywołującą.
Zwrócony identyfikator zadania jest używany zarówno do odpytywania stanu, jak i pobierania. Po pomyślnym wykonaniu zadania poproś o podpisany wyjściowy adres URL, zamiast osadzać klucz tajny pobierania.
Dane wyjściowe i ważne szczegóły#
Nowy plik PDF z fizycznie usunięt ą treścią w zaznaczonych obszarach i zastosowanym czarnym wypełnieniem.
Wymaga wizualnej oceny i weryfikacji względem oryginału. Nie jest to detektor redakcji semantycznej; nie gwarantuje, że zostaną znalezione wszystkie wystąpienia nazwy w innym miejscu pliku. Przecinające się obiekty wektorowe można całkowicie usunąć. Strony docelowe nie mogą być obrócone, a pliki PDF z polami formularzy muszą zostać najpierw spłaszczone. Istniejące podpisy cyfrowe zostają unieważnione.
Błędy, ponowne próby i rozliczenia