API Remplir les champs de formulaire PDF
Remplir les champs de texte et de case à cocher AcroForm modifiables existants avec des valeurs validées.
Sémantique du point de terminaison et de la tâche#
Code d'opération : fill_form
Commencez cette opération avec POST /v1/tasks et le code d'outil affiché ci-dessus. Importez et joignez les PDF source (ou utilisez les points de terminaison d'importation limités à la tâche), puis appelez POST /v1/tasks/{task_id}/process avec les paramètres d'opération.
Préremplir les documents d'intégration, les demandes et les formulaires commerciaux courants.
Entrées : Un PDF avec champs AcroForm. 1–100 noms de champs exacts ; les valeurs sont des chaînes ou des booléens.
Configuration et paramètres supplémentaires#
| Paramètre | Tapez | Comportement |
|---|---|---|
| valuesobligatoire | object | Mapper les noms de widgets PDF à string (texte) ou boolean (case à cocher). Les noms manquants et les types de champs non pris en charge échouent au lieu de réussir silencieusement. |
Les options sont validées par l'API. Les paramètres inconnus et les valeurs non prises en charge retournent une erreur au lieu d'être ignorés.
Séquence de demande en cours#
Programming language: cURL
Choisir une langue · faites défiler horizontalement pour les 10 langages 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.
Les packages téléchargeables générés couvrent uniquement le flux de travail des tâches. Les SDK de service complet nécessitent une spécification OpenAPI de runtime vérifiée ; les SDK de tâches Python, JavaScript et TypeScript diffusent les importations de fichiers ; les autres langues nécessitent des importations multipart signées implémentées par l'appelant.
L'ID de tâche retourné est utilisé à la fois pour l'interrogation du statut et la récupération. Une fois la tâche réussie, demandez une URL de sortie signée plutôt que d'intégrer un secret de téléchargement.
Résultat et détails importants#
Nouveau PDF modifiable avec valeurs de widget remplies et apparence mise à jour.
Les formulaires XFA, les champs de signature et les types de widget non pris en charge sont rejetés. Le résultat n'est pas aplati ni signé numériquement. Les signatures PDF existantes sont rejetées.
Erreurs, tentatives et facturation