Logo PDFHQ

Dokumen

Panduan Cepat API

Tugas pemrosesan PDFHQ pertama Anda menggunakan unggahan yang ditandatangani, file yang diverifikasi, dan tugas asinkron.

Kunci API sisi server Unggahan penyimpanan yang ditandatangani

Permintaan pertama yang berhasil#

Buat kunci API proyek HQTools di server. Mulai tugas, unggah PDF asli dengan jumlah byte dan SHA-256 yang benar, selesaikan unggahan, lampirkan ID-nya dan antrekan operasi.

Programming language: cURL

Pilih bahasa · gulir secara horizontal untuk semua 10 bahasa 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 ↓Panduan Python lengkap ↓ Panduan lengkap Bash/cURL ↓ Semua endpoint → Unggahan langsung → Penanganan kesalahan →

Paket yang dapat diunduh yang dihasilkan mencakup alur kerja tugas saja. SDK layanan penuh memerlukan spesifikasi OpenAPI runtime yang terverifikasi; SDK tugas Python, JavaScript, dan TypeScript melakukan streaming unggahan file; bahasa lain memerlukan unggahan multipart yang ditandatangani yang diimplementasikan oleh pemanggil.

Coba ulang aman dan pembuatan tugas idempoten →

Contoh lengkap, siap diunduh: CLI Python dan Bash/cURL . Mereka berhenti setelah mengutip kecuali Anda secara eksplisit menyetujui pemrosesan, dan mendukung melanjutkan tugas yang ada setelah respons yang tidak pasti.

Urutan cURL unggah-tanda tangan lengkap
# 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'

Hasil berhasil#

Respons tugas mulai 201 (ID ilustratif)
{
  "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"
  }
}

Tugas berkembang dari menunggu ke antrian/berjalan/berhasil atau gagal. Baca statusnya sebelum meminta URL unduhan.

Logo PDFHQ

Alat PDF dan intelijen dokumen. Siapkan, pahami, dan bekerja dengan dokumen Anda.

© 2026 PDFHQ. Semua hak dilindungi.