Ajouter des champs de formulaire à PDF
Formulaires → Ajouter des champs de formulaire à PDF
Le Ajouter des champs de formulaire à PDF API ajoute des champs de formulaire (zones de texte ou cases à cocher) à un PDF à des positions spécifiques. Vous envoyez le PDF comme Base64 (docContent), docName, formFieldType (Zone de texte ou case à cocher), fieldName, initialValue, positionX et positionY, Size, pages, et éventuellement async. Le API renvoie le PDF Les nouveaux champs de formulaire ont été ajoutés. Utilisez l'outil de test ci-dessous pour l'essayer ; vous trouverez plus de détails dans les sections suivantes.
Essayez d'ajouter des champs de formulaire à PDF API
Point final : POST /api/v2/AddFormField · Requis: api-key, docContent, docName, initialValue, positionX, positionY, fieldName, Size, pages, formFieldType
Utilisez le formulaire ci-dessous pour envoyer votre API clé, PDF (Base64), type de champ (zone de texte ou case à cocher), nom, position, taille et pages. La réponse est la PDF avec le(s) nouveau(x) champ(s) de formulaire. Aucun code requis, remplissez les champs et cliquez Envoyer une requête.
Aperçu, paramètres et cas d'utilisation
- Overview
- Parameters
- Use cases
Qu'est-ce que l'ajout de champs de formulaire à PDF?
Ce point de terminaison ajoute un ou plusieurs champs de formulaire à un PDF à des postes spécifiques. Vous choisissez formFieldType (Zone de texte ou case à cocher), définir fieldName, initialValue, positionX et positionY (coordonnées sur la page), Size, et les pages (par exemple 1, 1-3, 1,3,5, 1-). API renvoie le PDF avec les nouveaux champs remplissables. Utilisez-le pour transformer un élément statique PDF dans un formulaire ou ajoutez des champs supplémentaires à un formulaire existant.
Caractéristiques principales
- Types de champs: formFieldType: Zone de texte ou case à cocher.
- Position et taille: positionX, positionY (coordonnées); Size (taille du champ).
- Identité du champ: fieldName (nom unique du champ), initialValue (valeur par défaut).
- Ciblage de page: pages : 1, 1-3, 1,3,5, 1- (de la page 1 à la fin).
- Asynchrone: Utiliser async pour PDFs avec de nombreux champs.
À utiliser lorsque vous devez ajouter des champs de texte à remplir ou des cases à cocher à un document PDF. Associer à Remplir PDF Formulaire pour peupler les champs, ou Extraire les données du formulaire à partir de PDF lire les valeurs soumises.
API paramètres
| Paramètre | Taper | Requis | Description |
|---|---|---|---|
| api-key | chaîne | Oui | Ton PDF4me API clé, Base64 encodé. Récupérez-le depuis le tableau de bord. |
| docContent | base64 | Oui | PDF contenu du fichier (Base64). |
| docName | chaîne | Oui | PDF Nom du fichier avec l'extension .pdf. |
| initialValue | chaîne | Oui | Valeur initiale/par défaut du champ de formulaire. |
| positionX, positionY | entier | Oui | Position X et Y du champ sur la page. |
| fieldName | chaîne | Oui | Nom du champ de formulaire (identifiant unique). |
| Size | entier | Oui | Taille du champ de formulaire. |
| pages | chaîne | Oui | Page(s) : 1, 1-3, 1,3,5, 1,3,7-10, 1-. |
| formFieldType | chaîne | Oui | Zone de texte ou Case à cocher. |
| async | booléen | Non | Activer le traitement asynchrone. |
Quand utiliser Ajouter des champs de formulaire à PDF
- Création de formulaire: Ajouter des zones de texte et des cases à cocher à un PDF pour le rendre remplissable.
- ModèlesAjoutez des champs nommés à un modèle afin qu'ils puissent être remplis via Remplir PDF Formulaire ou votre application.
- Formes étendues: Ajouter des champs supplémentaires à un champ existant PDF formulaire (par exemple, date de signature, case à cocher d'approbation).
Pour les schémas de requête/réponse et des exemples de code, voir Ajouter des champs de formulaire au PDF dans le PDF4me API documents.
Prérequis
Avant d'utiliser ce point de terminaison, assurez-vous d'avoir :
- Un valide PDF4me API clé (Obtenez votre API Clé)
- UN PDF document dans Base64 format ou public URL à un PDF déposer
Format de réponse
Le API renvoie un PDF document contenant les champs de formulaire ajoutés aux positions spécifiées.