API de Preenchimento de Campos de Formulário PDF
Preencha campos de texto e caixa de seleção AcroForm editáveis existentes com valores validados.
Semântica de endpoint e tarefa#
Código de operação: fill_form
Inicie esta operação com POST /v1/tasks e o código da ferramenta mostrado acima. Envie e anexe PDFs de origem (ou use endpoints de upload com escopo de tarefa), depois chame POST /v1/tasks/{task_id}/process com configurações de operação.
Preencha previamente documentos de integração, aplicações e formulários comerciais rotineiros.
Entradas: Um PDF com campos AcroForm. 1–100 nomes de campos exatos; valores são strings ou booleanos.
Configuração e parâmetros extras#
| Configuração | Tipo | Comportamento |
|---|---|---|
| valuesobrigatório | object | Mapeie nomes de widget PDF para string (texto) ou boolean (caixa de seleção). Nomes ausentes e tipos de campo não suportados falham em vez de ter sucesso silenciosamente. |
As opções são validadas pela API. Configurações desconhecidas e valores não suportados retornam um erro em vez de serem ignorados.
Sequência de pedido em funcionamento#
Programming language: cURL
Escolha um idioma · role horizontalmente para todos os 10 idiomas de 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":"fill_form"}'
# 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":{"values":{"FullName":"Jane Doe","AgreeToTerms":true}}}'
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.
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.
O ID da tarefa retornado é usado tanto para sondagem de status quanto para recuperação. Após a tarefa ter sucesso, solicite uma URL de saída assinada em vez de incorporar um segredo de download.
Saída e detalhes importantes#
Novo PDF editável com valores de widget preenchidos e aparência atualizada.
Formulários XFA, campos de assinatura e tipos de widget não suportados são rejeitados. O resultado não é achatado nem assinado digitalmente. Assinaturas PDF existentes são rejeitadas.
Erros, tentativas e faturamento