Zarejestruj PDF (widoczne znaki) API
Umieść wpisane imię i nazwisko, datę lub narysowany obraz podpisu w pliku PDF, korzystając z mierzonego cyklu życia zadania. Nie weryfikuje to tożsamości ani nie wystawia podpisów kryptograficznych opartych na certyfikatach.
Semantyka punktów końcowych i zadań#
Kod operacji: sign
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.
Dodaj sprawdzony widoczny podpis, inicjały lub datę do dokumentów za zgodą osoby podpisującej.
Wejścia: Dokładnie jeden zapieczętowany plik PDF; 1–12 znaków; maksymalnie 100 MiB i 500 stron (limity planu mogą być niższe). Dokumenty zawierające już podpisy cyfrowe są odrzucane.
Konfiguracja i dodatkowe parametry#
| Ustawienie | Typ | Zachowanie |
|---|---|---|
| markswymagane | object[] | 1–12 znaków; każdy zawiera stronę (opartą na 1), x0, y0, x1, y1 w lewym górnym rogu punktów PDF i rodzaj: wpisany na maszynie, datowany lub narysowany. Wpisane znaki/daty zawierają tekst; rysowane znaki obejmują bajty PNG base64 (bez przedrostka adresu URL danych). Obrazy maksymalnie 96 KiB, 1600 × 600 pikseli. |
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":"sign"}'
# 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":{"marks":[{"kind":"typed","page":1,"x0":72,"y0":650,"x1":320,"y1":715,"text":"Jane Doe"}]}}'
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 zawierający widoczne znaczniki podpisu w żądanych prostokątach. Strony źródłowe i oryginalny tekst pozostają dostępne.
Ta operacja NIE powoduje utworzenia certyfikatu cyfrowego, ścieżki audytu odbiorcy, poświadczenia zgodności z prawem ani weryfikacji tożsamości osoby podpisującej. Istniejące podpisy cyfrowe w formacie PDF są odrzucane; obrócone strony docelowe nie są obsługiwane. W przypadku przepływów pracy związanych z podpisami odbiorców klasy biznesowej należy zintegrować dedykowanego dostawcę.
Błędy, ponowne próby i rozliczenia