Logo PDFHQ

Documentos

DocumentaçãoPrimeiros passos

Início Rápido da API

A sua primeira tarefa de processamento PDFHQ utilizando um carregamento assinado, ficheiro verificado e tarefa assíncrona.

Chaves de API do lado do servidor Uploads de armazenamento assinado

Primeira solicitação bem-sucedida#

Gere uma chave de API do projeto HQTools no servidor. Inicie uma tarefa, envie um PDF real com sua contagem de bytes correta e SHA-256, conclua o envio, anexe seu ID e coloque a operação na fila.

Programming language: cURL

Escolha um idioma · role horizontalmente para todos os 10 idiomas de 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 ↓Passo a passo completo em Python ↓ Passo a passo completo em Bash/cURL ↓ Todos os endpoints → Envios diretos → Tratamento de erros →

Pacotes baixáveis gerados cobrem apenas o fluxo de trabalho da tarefa. SDKs de serviço completo requerem uma especificação OpenAPI de tempo de execução verificada; os SDKs de tarefa Python, JavaScript e TypeScript transmitem uploads de arquivo; os outros idiomas requerem uploads multipart assinados implementados pelo chamador.

Tentativas seguras e criação de tarefas idempotentes →

Exemplos completos e prontos para download: CLI do Python e Bash/cURL . Eles param após citar, a menos que você aprove explicitamente o processamento, e suportam retomar uma tarefa existente após uma resposta incerta.

Sequência cURL de upload assinado completa
# 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'

Resultado bem-sucedido#

Resposta de início de tarefa 201 (IDs ilustrativos)
{
  "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"
  }
}

A tarefa avança de aguardando para enfileirada/em execução/bem-sucedida ou falhou. Leia seu status antes de solicitar uma URL de download.

Logo PDFHQ

Ferramentas PDF e inteligência de documentos. Prepare, compreenda e trabalhe com seus documentos.

© 2026 PDFHQ. Todos os direitos reservados.