API voor PDF-formuliervelden invullen
Vul bestaande bewerkbare AcroForm-tekst- en selectievakjes met gevalideerde waarden.
Eindpunt- en taaksemantiek#
Bewerkingscode: fill_form
Start deze bewerking met POST /v1/tasks en de hierboven weergegeven toolcode. Upload en voeg bron-PDF's toe (of gebruik taakgerelateerde upload-eindpunten), vervolgens roep aan POST /v1/tasks/{task_id}/process met bewerkingsinstellingen.
Vul onboardingdocumenten, aanvragen en routineformulieren vooraf in.
Invoer: Eén PDF met AcroForm-velden. 1–100 exacte veldnamen; waarden zijn strings of booleans.
Configuratie en extra parameters#
| Instelling | Typ | Gedrag |
|---|---|---|
| valuesverplicht | object | Wijs PDF-widgetnamen toe aan string (tekst) of boolean (selectievakje). Ontbrekende namen en niet-ondersteunde veldtypen mislukken in plaats van stilzwijgend te slagen. |
Opties worden gevalideerd door de API. Onbekende instellingen en niet-ondersteunde waarden retourneren een fout in plaats van te worden genegeerd.
Werkende aanvraagvolgorde#
Programming language: cURL
Kies een taal · scroll horizontaal voor alle 10 SDK-talen
# 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.
Gegenereerde downloadbare pakketten dekken alleen de taakwerkstroom. Full-service SDK's vereisen een geverifieerde runtime OpenAPI-specificatie; de Python-, JavaScript- en TypeScript-taak-SDK's streamen bestandsuploads; de andere talen vereisen ondertekende multipart-uploads geïmplementeerd door de aanroeper.
De geretourneerde taak-ID wordt gebruikt voor zowel statuspolling als ophalen. Nadat de taak is voltooid, vraagt u een ondertekende uitvoer-URL aan in plaats van een downloadgeheim in te sluiten.
Uitvoer en belangrijke details#
Nieuwe bewerkbare PDF met ingevulde widgetwaarden en bijgewerkt uiterlijk.
XFA-formulieren, handtekeningvelden en niet-ondersteunde widgettypen worden afgewezen. Het resultaat is niet afgevlakt of digitaal ondertekend. Bestaande PDF-handtekeningen worden afgewezen.
Fouten, nieuwe pogingen en facturering