Avvio rapido API
Il tuo primo compito di elaborazione PDFHQ utilizzando un caricamento firmato, un file verificato e un'attività asincrona.
Primo richiesta riuscita#
Genera una chiave API del progetto HQTools sul server. Avvia un'attività, carica un PDF reale con il conteggio di byte e SHA-256 corretti, completa il caricamento, allega il suo ID e accoda l'operazione.
Programming language: cURL
Scegli una lingua · scorri orizzontalmente per tutti i 10 linguaggi 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":"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.
I pacchetti scaricabili generati coprono solo il flusso di lavoro dell'attività. Gli SDK full-service richiedono una specifica OpenAPI di runtime verificata; gli SDK delle attività Python, JavaScript e TypeScript trasmettono i caricamenti di file; gli altri linguaggi richiedono caricamenti multipart firmati implementati dal chiamante.
Esempi completi e pronti per il download: CLI Python e Bash/cURL . Si fermano dopo aver citato a meno che tu non approvi esplicitamente l'elaborazione e supportano la ripresa di un'attività esistente dopo una risposta incerta.
# 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'Risultato riuscito#
{
"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"
}
}L'attività avanza da in attesa a in coda/in esecuzione/completata o non riuscita. Leggi il suo stato prima di richiedere un URL di download.
