PDF-Formularfelder ausfüllen API
Fülle vorhandene bearbeitbare AcroForm-Text- und Kontrollkästchen-Felder mit validierten Werten aus.
Endpunkt- und Task-Semantik#
Operationscode: fill_form
Starten Sie diesen Vorgang mit POST /v1/tasks und den oben angezeigten Tool-Code. Lade Quell-PDFs hoch und füge sie an (oder verwende Task-bezogene Upload-Endpunkte), dann rufe auf POST /v1/tasks/{task_id}/process mit Operationseinstellungen.
Onboarding-Dokumente, Anträge und Routinegeschäftsformulare ausfüllen.
Eingaben: Ein PDF mit AcroForm-Feldern. 1–100 exakte Feldnamen; Werte sind Strings oder Booleans.
Konfiguration und zusätzliche Parameter#
| Einstellung | Typ | Verhalten |
|---|---|---|
| valueserforderlich | object | Ordne PDF-Widget-Namen zu String (Text) oder Boolean (Kontrollkästchen). Fehlende Namen und nicht unterstützte Feldtypen schlagen fehl, anstatt stillschweigend erfolgreich zu sein. |
Optionen werden von der API validiert. Unbekannte Einstellungen und nicht unterstützte Werte geben einen Fehler zurück, statt ignoriert zu werden.
Arbeitende Anforderungssequenz#
Programming language: cURL
Wähle eine Sprache · scrolle horizontal für alle 10 SDK-Sprachen
# 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.
Generierte herunterladbare Pakete decken nur den Task-Workflow ab. Vollständige SDKs erfordern eine verifizierte OpenAPI-Spezifikation; die Python-, JavaScript- und TypeScript-Task-SDKs streamen Datei-Uploads; die anderen Sprachen erfordern signierte Multipart-Uploads, die vom Aufrufer implementiert werden.
Die zurückgegebene Aufgaben-ID wird sowohl für die Statusabfrage als auch für den Abruf verwendet. Nachdem die Aufgabe erfolgreich war, fordern Sie eine signierte Ausgabe-URL an, anstatt ein Download-Geheimnis einzubetten.
Ausgabe und wichtige Details#
Neues bearbeitbares PDF mit ausgefüllten Widget-Werten und aktualisiertem Erscheinungsbild.
XFA-Formulare, Signaturfelder und nicht unterstützte Widget-Typen werden abgelehnt. Das Ergebnis wird nicht reduziert oder digital signiert. Bestehende PDF-Signaturen werden abgelehnt.
Fehler, Wiederholungen und Abrechnung