API Compila campi modulo PDF
Compila i campi di testo e caselle di controllo AcroForm modificabili esistenti con valori convalidati.
Semantica endpoint e attività#
Codice operazione: fill_form
Avvia questa operazione con POST /v1/tasks e il codice dello strumento mostrato sopra. Carica e allega i PDF di origine (o usa gli endpoint di caricamento con ambito task), quindi chiama POST /v1/tasks/{task_id}/process con impostazioni di operazione.
Precompila documenti di onboarding, applicazioni e moduli aziendali di routine.
Input: Un PDF con campi AcroForm. 1–100 nomi di campo esatti; i valori sono stringhe o booleani.
Configurazione e parametri aggiuntivi#
| Impostazione | Tipo | Comportamento |
|---|---|---|
| valuesobbligatorio | object | Mappa i nomi dei widget PDF a stringa (testo) o booleano (casella di controllo). I nomi mancanti e i tipi di campo non supportati generano errore anziché avere successo silenziosamente. |
Le opzioni sono convalidate dall'API. Le impostazioni sconosciute e i valori non supportati restituiscono un errore invece di essere ignorati.
Sequenza di richiesta in corso#
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":"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.
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.
L'ID attività restituito viene utilizzato sia per il polling dello stato che per il recupero. Dopo il completamento dell'attività, richiedi un URL di output firmato anziché incorporare un segreto di download.
Output e dettagli importanti#
Nuovo PDF modificabile con valori widget compilati e aspetto aggiornato.
I moduli XFA, i campi firma e i tipi di widget non supportati vengono rifiutati. Il risultato non è appiattito né firmato digitalmente. Le firme PDF esistenti vengono rifiutate.
Errori, tentativi e fatturazione