Ajouter des champs de formulaire à un PDF - API de formulaire interactif

PDF4me Ajouter des champs de formulaire au PDF vous permet d'ajouter des champs de formulaire interactifs à PDF documents. Ceci API processus de service PDF ajoute des champs de formulaire (zones de texte et cases à cocher) à des emplacements spécifiques sur des pages spécifiées. API reçoit PDF paramètres de contenu et de champ de formulaire via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à la prise en charge du positionnement flexible, des types de champs personnalisés et du ciblage de pages, cette solution est idéale pour l'automatisation des documents et les applications interactives. PDF Flux de travail de développement.

Articles de blog connexes

Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.

En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.

Consultez le blog →

Authentification de votre requête API

Pour accéder au PDF4me REST APIChaque requête doit inclure des informations d'authentification valides. L'authentification garantit la sécurité des communications et confirme votre identité en tant qu'utilisateur autorisé. REST API.

Get your api Key

Caractéristiques principales

Types de champs de formulaire: Ajouter des champs de formulaire TextBox et CheckBox à PDF documents
Positionnement précis: Placement du champ de contrôle avec des coordonnées X et Y exactes
dimensionnement personnalisé des champsAjuster les dimensions des champs du formulaire pour qu'elles correspondent aux exigences de conception
Ciblage de page flexibleAppliquer les champs de formulaire à des pages spécifiques ou à des documents entiers
Valeurs initiales: Définir les valeurs par défaut des champs de formulaire
Base64 Encodage: Sécuriser la transmission du contenu des fichiers à l'aide de Base64 encodage
Simple API Intégration: RESTful API conçu pour l'automatisation PDF flux de travail de création de formulaires

Point de terminaison de l'API REST

Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations d'ajout de champs de formulaire sont effectuées via un point de terminaison unique :

Méthode: POST
Point final : /api/v2/AddFormField

Paramètres de l'API REST

Liste complète des paramètres pour l'ajout de champs de formulaire au PDF REST APILes paramètres sont organisés par catégorie pour une meilleure compréhension et une mise en œuvre plus aisée.

Important: Les paramètres marqués d'un astérisque (*) sont obligatoires et doivent être fournis pour le API pour fonctionner correctement.

Paramètres requis

Paramètre	Taper	Description	Exemple
docContent*	Base64	Le contenu de l'entrée PDF fichier encodé en Base64	`JVBERi...`
Nom du document*	String	Source PDF Nom de fichier avec l'extension .pdf	`output.pdf`
valeur initiale*	String	Valeur initiale du champ de formulaire	`New input text`
positionX*	Integer	Position X du champ de formulaire sur la page	`300`
positionY*	Integer	Position verticale du champ de formulaire sur la page	`300`
nom_du_champ*	String	Nom du champ du formulaire	`Input Field Name`
Taille*	Integer	Taille du champ de formulaire	`4`
pages*	String	Options de pagination : « 1 » pour la page 1, « 1,3,5 » pour des pages spécifiques, « 2-5 » pour une plage de pages, « 1,3,7-10 » pour un affichage mixte, « 1- » pour les pages de 1 à la fin.	`1`
type de champ de formulaire*	String	Type de champ de formulaire : Zone de texte ou Case à cocher	`TextBox`

Paramètres optionnels

Paramètre	Taper	Description	Exemple
asynchrone	Boolean	Activer le traitement asynchrone. Lorsque `true`, le API renvoie un statut 202 et fournit un système d'interrogation URL dans l'en-tête Emplacement	`true`

Sortir

Le PDF4me Ajouter des champs de formulaire au PDF REST API renvoie des réponses différentes selon le mode de traitement. API renvoie le PDF comme données binaires pour le traitement synchrone ou fournit un système d'interrogation URL pour le traitement asynchrone.

Success Response
Asynchronous Processing
Error Responses
Response Format Details

Traitement synchrone (par défaut)

Quand async n'est pas défini ou est défini sur false, le API traite la demande immédiatement :

Code d'état : 200 OK

Type de contenu : application/pdf ou application/octet-stream

Corps de la réponse :

Le API renvoie le PDF fichier directement sous forme de données binaires (non JSON).

Mode d'emploi :

Le corps de la réponse contient le binaire PDF données
Enregistrez directement le contenu de la réponse en tant que PDF déposer
Non Base64 Le décodage est nécessaire pour les réponses binaires.

Exemple (JavaScript) :

const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly

Traitement asynchrone

Quand async: true est réglé, le API traite la requête de manière asynchrone :

Code d'état : 202 Accepted

En-têtes de réponse :

Location: https://api.pdf4me.com/api/v2/AddFormField/poll/12345-abcde-67890

Processus de sondage :

Extraire le Location En-tête de la réponse 202
Sondage URL en utilisant GET demandes
Continuez à sonder jusqu'à ce que vous receviez un 200 OK statut
La réponse finale contient le binaire PDF données

Exemple de sondage :

// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');

// Poll until complete
while (true) {
  const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
  if (pollResponse.status === 200) {
    const pdfBlob = await pollResponse.blob();
    // Process binary PDF
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Réponses d'erreur

Code d'état	Description	Exemple de réponse
400 Bad Request	Paramètres de requête invalides ou champs obligatoires manquants	`{"error": "Missing required parameter: fieldName"}`
401 Unauthorized	Invalide ou manquant API clé	`{"error": "Unauthorized"}`
500 Internal Server Error	Erreur serveur lors du traitement	`{"error": "Internal server error"}`

Exemple de requête

En-tête

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Note: Le API La clé doit être Base64 encodé. Obtenez votre API clé de la PDF4me Tableau de bord

Charge utile

{
  "docContent": "Please put PDF base64 content",
  "docName": "output.pdf",
  "initialValue": "input text",
  "positionX": 300,
  "positionY": 300,
  "fieldName": "Input Field Name",
  "Size": 4,
  "pages": "1",
  "formFieldType": "TextBox"
}

Exemples de code

Le PDF4me Ajouter des champs de formulaire au PDF REST API propose des exemples de code dans plusieurs langages de programmation. Choisissez le langage qui convient le mieux à votre environnement de développement :

C# Exemple (CSharp)

Complet C# implémentation pour l'ajout de champs de formulaire PDF:

View C# Sample

Fonctionnalités de création de champs de formulaire

Types de champs de formulaire

Champs de texteCréer des champs de saisie de texte pour la saisie de données utilisateur et le remplissage de formulaires.
Champs à cocherAjouter des cases à cocher pour les options de sélection et de confirmation
Tailles personnalisées: Ajuster les dimensions des champs pour correspondre aux exigences de conception et aux besoins du contenu
Résultats professionnelsCréation de champs de formulaire de haute qualité avec des fonctionnalités précises
Traitement avancé: Prise en charge des mises en page de formulaires complexes et des agencements de champs

Positionnement et mise en page

Coordonnées précises: Contrôlez le positionnement du champ avec des valeurs de position X et Y exactes
Positionnement flexible: Prise en charge de toute position de page et de toute disposition de champ
Ciblage de pageAppliquer les champs de formulaire à des pages spécifiques ou à des documents entiers
Tailles personnaliséesDimensions de terrain ajustables pour une conception de forme optimale
Mise en page professionnelle: Placement cohérent des champs de formulaire sur toutes les pages cibles

Fonctionnalités avancées

Valeurs initialesDéfinissez des valeurs de champ par défaut pour une meilleure expérience utilisateur.
Dénomination des champs: Noms de champs personnalisés pour la collecte et le traitement des données de formulaire
Création professionnelleGénération de champs de formulaire de haute qualité avec des fonctionnalités claires
Options flexibles: Paramètres de champs de formulaire personnalisables pour des exigences spécifiques

Cas d'utilisation et applications industrielles

Legal & Professional Services
Healthcare & Medical
Finance & Banking
Human Resources
Business & Enterprise

Cas d'utilisation des services juridiques et professionnels

Formulaires de contrat: Ajouter des champs de formulaire aux contrats et accords pour les signatures numériques
Documentation juridiqueCréer des formulaires interactifs pour le traitement des documents juridiques
Formulaires de conformité: Créer des formulaires pour la conformité réglementaire et la documentation
Accueil des clientsCréer des formulaires d'admission des clients pour les services juridiques

Obtenez de l'aide

Get Your API Key API Samples Getting Started

Authentification de votre requête API​

Caractéristiques principales​

Point de terminaison de l'API REST​

Paramètres de l'API REST​

Paramètres requis​

Paramètres optionnels​

Sortir​

Exemple de requête​

En-tête​

Charge utile​

Exemples de code​

Fonctionnalités de création de champs de formulaire​

Types de champs de formulaire​

Positionnement et mise en page​

Fonctionnalités avancées​

Cas d'utilisation et applications industrielles​

Obtenez de l'aide​