Logo PDFHQ

Dokumenty

DokumentacjaPierwsze kroki

Szybki start interfejsu API

Twoje pierwsze zadanie przetwarzania PDFHQ przy użyciu podpisanego przesyłania, zweryfikowanego pliku i zadania asynchronicznego.

Klucze API po stronie serwera Podpisane przesyłanie danych do magazynu

Pierwsza udana prośba#

Wygeneruj klucz API projektu HQTools na serwerze. Rozpocznij zadanie, prześlij prawdziwy plik PDF z poprawną liczbą bajtów i SHA-256, zakończ przesyłanie, dołącz jego identyfikator i wstaw do kolejki operację.

Programming language: cURL

Wybierz język · przewiń w poziomie, aby zobaczyć wszystkie 10 języków SDK

API example · cURL
# 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":"compress"}'

# 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":{"compression_level":"recommended"}}'

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.

All 10 SDKs ↓Ukończ przewodnik po Pythonie ↓ Ukończ instruktaż Bash/cURL ↓ Wszystkie punkty końcowe → Przesyłanie bezpośrednie → Obsługa błędów →

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ą.

Bezpieczne ponowne próby i idempotentne tworzenie zadań →

Kompletne, gotowe do pobrania przykłady: Interfejs wiersza polecenia Pythona i Bash/cURL . Zatrzymują się po zacytowaniu, chyba że wyraźnie zatwierdzisz przetwarzanie, i obsługują wznowienie istniejącego zadania po niepewnej odpowiedzi.

Kompletna sekwencja cURL przesyłania podpisanego
# 1. Start a task. Save the task_id from its JSON response.
curl -X POST https://api.pdfhq.io/v1/tasks \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"tool":"compress"}'

# 2. Start a task-scoped upload. Use real file size and SHA-256 values.
curl -X POST https://api.pdfhq.io/v1/tasks/TASK_ID/uploads \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"filename":"report.pdf","size_bytes":12345,"sha256":"ACTUAL_64_CHAR_DIGEST","content_type":"application/pdf"}'

# 3. POST signed "fields" plus binary file directly to returned S3 "url".
#    Then complete it; PDFHQ automatically attaches the verified file.
curl -X POST https://api.pdfhq.io/v1/tasks/TASK_ID/uploads/UPLOAD_ID/complete -H 'x-api-key: YOUR_API_KEY'

# 4. Queue work (safe to retry with IDENTICAL options), then poll until succeeded.
curl -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":{"compression_level":"recommended"}}'
curl https://api.pdfhq.io/v1/tasks/TASK_ID -H 'x-api-key: YOUR_API_KEY'

# 5. Once succeeded, get a short-lived signed URL.
curl https://api.pdfhq.io/v1/tasks/TASK_ID/download-url -H 'x-api-key: YOUR_API_KEY'

Pomyślny wynik#

201 Uruchom odpowiedź na zadanie (ilustracyjne identyfikatory)
{
  "task_id": "uuid",
  "tool": "compress",
  "status": "waiting",
  "upload_ids": [],
  "job_id": null,
  "progress": 0,
  "output_ready": false,
  "links": {
    "self": "/v1/tasks/uuid",
    "files": "/v1/tasks/uuid/files",
    "process": "/v1/tasks/uuid/process"
  }
}

Zadanie przechodzi z oczekiwania do kolejki/uruchomienia/powiodło się lub nie powiodło się. Przeczytaj jego status przed zażądaniem adresu URL pobierania.

Logo PDFHQ

Narzędzia PDF i inteligencja dokumentów. Przygotuj, zrozum i pracuj ze swoimi dokumentami.

© 2026 PDFHQ. Wszystkie prawa zastrzeżone.