Extraire les données du formulaire à partir de PDF - Analyseur de champs API
PDF4me Extraire les données du formulaire PDF vous permet d'extraire toutes les données et valeurs des champs de formulaire à partir de PDF documents contenant des formulaires à remplir. API processus de service PDF extrait les fichiers et les informations, valeurs et propriétés des champs de formulaire à partir de ceux-ci. PDF formes. Les API reçoit PDF contenu via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à la prise en charge de différents types de champs de formulaire et de la sortie de données structurées, cette solution est idéale pour les flux de travail de traitement de formulaires et les plateformes d'extraction de données.
Authentification de votre API Demande
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.
Caractéristiques principales
- Extraction des champs de formulaireExtraire tous les types de champs de formulaire, y compris les champs de texte, les cases à cocher, les boutons radio, les listes déroulantes et les champs de signature.
- Sortie de données structuréesRécupérer les données du formulaire dans un format structuré JSON format pour une intégration facile
- Propriétés du champExtraire les noms de champs, les valeurs, les types et les propriétés de validation
- Base64 Encodage: Sécuriser la transmission du contenu des fichiers à l'aide de Base64 encodage
- Simple API Intégration: RESTful API conçu pour les flux de travail de traitement automatisé des formulaires
REST API Point de terminaison
Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations d'extraction de données de formulaire sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
/api/v2/ExtractPdfFormData
REST API Paramètres
Liste complète des paramètres pour l'extraction des données du formulaire. 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 |
|---|---|---|---|
| docName* | String | Source PDF Nom de fichier avec l'extension .pdf appropriée pour l'identification du document et le traitement d'extraction des données du formulaire | output.pdf |
| docContent* | Base64 (String) | Le contenu de l'entrée PDF fichier encodé en Base64 format pour l'analyse des champs de formulaire et le traitement d'extraction des données | JVBERi... |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| async | Boolean | Activer le traitement asynchrone. Lorsque true, le API retours 202 Accepted avec un Location en-tête pour l'interrogation du résultat | true |
Sortir
Le PDF4me Extraire les données du formulaire PDF REST API renvoie des réponses différentes selon le mode de traitement. API renvoie les données extraites des champs de formulaire sous forme de JSON réponse.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Traitement synchrone (par défaut)
Quand async est false ou non fourni, le API renvoie immédiatement les données extraites du formulaire.
Code d'état : 200 OK
Format de réponse :
{
"formFields": [
{
"fieldName": "Name",
"fieldValue": "John Doe",
"fieldType": "text"
},
{
"fieldName": "Email",
"fieldType": "text"
},
{
"fieldName": "Date",
"fieldValue": "2024-01-15",
"fieldType": "date"
}
]
}
La réponse contient un tableau de champs de formulaire avec leurs noms, leurs valeurs et leurs types.
Traitement asynchrone
Quand async est true, le API traite le document de manière asynchrone.
Réponse initiale :
Code d'état : 202 Accepted
En-têtes de réponse :
Location: https://api.pdf4me.com/api/v2/ExtractPdfFormDataStatus/{operationId}
Corps de la réponse :
{
"traceId": "operation-trace-id"
}
Sondage pour les résultats :
Utilisez le Location en-tête URL sondage pour vérifier l'achèvement :
const response = await fetch(locationUrl, {
headers: { 'Authorization': 'Basic ' + apiKey }
});
// Continue polling until status code is 200
if (response.status === 200) {
const result = await response.json();
// Process extracted form data
}
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: docContent"} |
| 401 Unauthorized | Invalide ou manquant API clé | {"error": "Unauthorized"} |
| 408 Délai d'attente dépassé | Délai de traitement de la requête dépassé | {"error": "Request timeout"} |
| 500 Internal Server Error | Erreur serveur lors du traitement | {"error": "Internal server error"} |
Comprendre le JSON Réponse
La réponse d'extraction de données du formulaire est une JSON objet contenant un tableau de champs de formulaire :
- champs de formulaire: Array des objets de champ de formulaire
- nom_du_champ: Le nom du champ de formulaire
- valeur du champ: La valeur saisie dans le champ du formulaire
- type de champ: Le type de champ de formulaire (texte, case à cocher, bouton radio, date, etc.)
Types de champs :
Les types de champs de formulaire courants comprennent :
text: Champs de saisie de textecheckbox: Champs de type case à cocher (valeurs booléennes)radio: Groupes de boutons radiodate: Champs de sélection de datenumber: Champs de saisie numériquedropdown: Champs de liste déroulante/sélectionsignature: Champs de signature numérique
Exemple de requête
En-tête
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Note:
- Obtenez votre API clé de la PDF4me Tableau de bord
- Le API La clé doit être Base64 encodé et préfixé par « Basic » dans le Authorization en-tête
- Exemple : Si votre API La clé est
abc123, encodez-le en Base64 et utiliserAuthorization: Basic YWJjMTIz
Charge utile
Demande de base :
{
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"docName": "output.pdf"
}
Avec le traitement asynchrone :
{
"docContent": "JVBERi0xLjQKJeLjz9MK...",
"docName": "output.pdf",
"async": true
}
Exemples de code
Le PDF4me Extraire les données du formulaire 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# Exemple (CSharp)
Complet C# implémentation pour l'extraction de données de formulaire à partir de PDF:
Java Échantillon
Java implémentation avec gestion complète des erreurs et traitement des réponses :
JavaScript Échantillon
Node.js et compatible avec les navigateurs JavaScript mise en œuvre:
Python Échantillon
Python implémentation avec la bibliothèque requests et JSON manutention:
Google Apps Script Échantillon
Google Apps Script mise en œuvre pour Google Workspace intégration :
Fonctionnalités d'extraction de données de formulaire
Capacités d'analyse sur le terrain
- Détection complète sur le terrainIdentifiez tous les champs de formulaire, y compris les champs cachés et calculés.
- Extraction de valeurExtraire les valeurs actuelles et les valeurs par défaut de tous les types de champs
- Analyse immobilièreRécupérer les propriétés des champs, notamment leurs noms, types, positions et règles de validation.
- Validation des donnéesVérifier l'intégrité et la conformité au format des données de terrain
Traitement des formulaires
- PDF Analyse de la forme: Analyse approfondie de PDF structure de forme et relations de champ
- Reconnaissance du type de champIdentification automatique des différents types de champs de formulaire
- Traitement par lotsTraiter plusieurs formulaires et extraire des données à partir de structures de formulaires complexes.
- Sortie structuréeGénérer des données organisées et structurées pour une intégration facile
Fonctionnalités avancées
- Cartographie de terrainAssocier les champs du formulaire aux colonnes de la base de données ou aux champs de l'application
- Transformation des données: Convertir les données du formulaire en différents formats de sortie (JSON, XML, CSV)
- Règles de validationExtraire et appliquer les règles et contraintes de validation de formulaire
- Résultats professionnelsExtraction de haute qualité adaptée aux applications d'entreprise
Cas d'utilisation et applications industrielles
- Document Management & Processing
- Business & Finance
- Legal & Compliance
- Healthcare & Medical
- Government & Public Sector
- Education & Research
Cas d'utilisation de la gestion et du traitement des documents
- Collecte de données de formulaireExtraire les données des champs remplis PDF formulaires pour le stockage de bases de données
- Numérisation de documentsConvertir les formulaires papier en données numériques via PDF traitement
- Migration de donnéesExtraire les données des formulaires lors de la migration des documents et des mises à jour du système
- Analyse de la formeAnalyser les taux de remplissage des formulaires et les modèles d'utilisation des champs
Cas d'utilisation en affaires et en finance
- Traitement des facturesExtraire les données des formulaires de facture et des bons de commande.
- Traitement des demandesTraiter les demandes de prêt, les déclarations de sinistres et les formulaires d'inscription
- Données d'enquêteExtraire les réponses des enquêtes et formulaires de commentaires clients
- Formulaires de conformité: Traiter les formulaires de conformité réglementaire et les documents fiscaux
Cas d'utilisation juridiques et de conformité
- Formulaires juridiquesExtraire des données à partir de documents juridiques et de formulaires judiciaires
- Traitement des contrats: Traiter les formulaires de contrat et les données d'accord
- Conformité réglementaireExtraire des données des formulaires de conformité et des documents réglementaires
- Collecte de preuvesExtraire les données des formulaires à des fins de preuve et de documentation légales
Cas d'utilisation dans le domaine de la santé et du médical
- Formulaires pour les patientsExtraire les données des formulaires d'inscription des patients et d'antécédents médicaux.
- Réclamations d'assurance: Traiter les formulaires de réclamation d'assurance et les documents de facturation médicale
- Essais cliniquesExtraire les données des formulaires de recherche et des documents d'études cliniques
- Dossiers médicaux: Traiter les formulaires médicaux et les documents d'information des patients
Cas d'utilisation dans le secteur public et gouvernemental
- Services aux citoyensExtraire des données des formulaires gouvernementaux et des demandes des citoyens
- Traitement fiscal: Traiter les formulaires fiscaux et les documents de déclaration financière
- Demandes de permisExtraire les données des formulaires de demande de permis et de licence
- Archives publiques: Traiter les documents publics et les documents officiels du gouvernement
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Formulaires étudiantsExtraire les données des formulaires d'inscription et des demandes d'admission universitaires
- Données de recherche: Formulaires de recherche sur les processus et réponses aux enquêtes
- Formulaires d'évaluationExtraire les données des formulaires d'évaluation et d'appréciation
- Formulaires administratifs: Traiter les formulaires administratifs et les documents institutionnels