API Hızlı Başlangıç
İmzalı yükleme, doğrulanmış dosya ve asenkron görev kullanan ilk PDFHQ işleme göreviniz.
İlk başarılı istek#
Sunucuda bir HQTools proje API anahtarı oluşturun. Bir görev başlatın, doğru bayt sayısı ve SHA-256 ile gerçek bir PDF yükleyin, yüklemeyi tamamlayın, kimliğini ekleyin ve işlemi kuyruğa alın.
Programming language: cURL
Bir dil seçin · tüm 10 SDK dili için yatay kaydırın
# 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.
Oluşturulan indirilebilir paketler yalnızca görev iş akışını kapsar. Tam hizmet SDK'ları doğrulanmış bir çalışma zamanı OpenAPI belirtimi gerektirir; Python, JavaScript ve TypeScript görev SDK'ları dosya yüklemelerini akışa alır; diğer diller, arayan tarafından uygulanan imzalı çok parçalı yüklemeler gerektirir.
Tam, indirmeye hazır örnekler: Python CLI'si ve Bash/cURL . Alıntı yaptıktan sonra durur ve siz açıkça işlemeyi onaylamadığınız sürece, belirsiz bir yanıttan sonra mevcut bir görevi sürdürmeyi destekler.
# 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'Başarılı sonuç#
{
"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"
}
}Görev bekleme durumundan sıraya alınmış/çalışıyor/başarılı veya başarısız durumuna ilerler. İndirme URL'si istemeden önce durumunu okuyun.
