Estrai i dati del modulo da PDF - Analizzatore di campi API
PDF4me Estrai i dati del modulo da PDF consente di estrarre tutti i dati e i valori dei campi del modulo da PDF documenti contenenti moduli compilabili. Questo API processi di servizio PDF file ed estrae informazioni sui campi del modulo, valori e proprietà da PDF forme. Il API riceve PDF contenuto attraverso REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Grazie al supporto di vari tipi di campi modulo e all'output di dati strutturati, questa soluzione è ideale per i flussi di lavoro di elaborazione dei moduli e le piattaforme di estrazione dati.
Autenticazione del tuo API Richiesta
Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.
Caratteristiche principali
- Estrazione del campo del modulo: Estrai tutti i tipi di campi del modulo, inclusi campi di testo, caselle di controllo, pulsanti di opzione, menu a tendina e campi per la firma.
- Output di dati strutturati: Recupera i dati del modulo in formato strutturato JSON formato per una facile integrazione
- Proprietà del campo: Estrai i nomi dei campi, i valori, i tipi e le proprietà di convalida
- Base64 Codifica: Trasmissione sicura del contenuto dei file tramite Base64 codifica
- Semplice API Integrazione: RESTful API progettato per flussi di lavoro automatizzati di elaborazione dei moduli
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP metodi per interagire con le risorse. Tutte le operazioni di estrazione dei dati dai moduli vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
/api/v2/ExtractPdfFormData
REST API Parametri
Elenco completo dei parametri per l'estrazione dei dati del modulo da PDF REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori e devono essere forniti per il API per funzionare correttamente.
Parametri richiesti
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| docName* | String | Fonte PDF Nome del file con estensione .pdf corretta per l'identificazione del documento e l'estrazione dei dati del modulo. | output.pdf |
| docContent* | Base64 String) | Il contenuto dell'input PDF file codificato in Base64 formato per l'analisi dei campi del modulo e l'elaborazione dell'estrazione dei dati | JVBERi... |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| async | Boolean | Abilita l'elaborazione asincrona. Quando true, IL API resi 202 Accepted con un Location intestazione per il sondaggio del risultato | true |
Produzione
IL PDF4me Estrai i dati del modulo da PDF REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce i dati del campo del modulo estratto come un JSON risposta.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Elaborazione sincrona (impostazione predefinita)
Quando async È false o non fornito, il API restituisce immediatamente i dati del modulo estratti.
Codice di stato: 200 OK
Formato di risposta:
{
"formFields": [
{
"fieldName": "Name",
"fieldValue": "John Doe",
"fieldType": "text"
},
{
"fieldName": "Email",
"fieldType": "text"
},
{
"fieldName": "Date",
"fieldValue": "2024-01-15",
"fieldType": "date"
}
]
}
La risposta contiene un array di campi del modulo con i relativi nomi, valori e tipi.
Elaborazione asincrona
Quando async È true, IL API elabora il documento in modo asincrono.
Risposta iniziale:
Codice di stato: 202 Accepted
Intestazioni di risposta:
Location: https://api.pdf4me.com/api/v2/ExtractPdfFormDataStatus/{operationId}
Corpo della risposta:
{
"traceId": "operation-trace-id"
}
Sondaggio per i risultati:
Utilizzare il Location intestazione URL per votare il completamento:
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
}
Risposte di errore
| Codice di stato | Descrizione | Esempio di risposta |
|---|---|---|
| 400 Bad Request | Parametri di richiesta non validi o campi obbligatori mancanti | {"error": "Missing required parameter: docContent"} |
| 401 Unauthorized | Non valido o mancante API chiave | {"error": "Unauthorized"} |
| 408 Timeout della richiesta | Timeout di elaborazione della richiesta | {"error": "Request timeout"} |
| 500 Internal Server Error | Errore del server durante l'elaborazione | {"error": "Internal server error"} |
Comprendere il JSON Risposta
La risposta all'estrazione dei dati del modulo è una JSON oggetto contenente un array di campi modulo:
- campi modulo: Array degli oggetti del campo modulo
- nomecampo: Il nome del campo del modulo
- valore_campo: Il valore inserito nel campo del modulo
- tipo di campo: Il tipo di campo del modulo (testo, casella di controllo, pulsante di opzione, data, ecc.)
Tipi di campo:
I tipi di campi modulo più comuni includono:
text: Campi di input di testocheckboxCampi di tipo casella di controllo (valori booleani)radio: Gruppi di pulsanti radiodateCampi di selezione della datanumber: Campi di input numericidropdownCampi a discesa/selezionesignature: Campi della firma digitale
Esempio di richiesta
Intestazione
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota:
- Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
- IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
- Esempio: se il tuo API la chiave è
abc123, codificalo in Base64 e utilizzareAuthorization: Basic YWJjMTIz
Carico utile
Richiesta di base:
{
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"docName": "output.pdf"
}
Con elaborazione asincrona:
{
"docContent": "JVBERi0xLjQKJeLjz9MK...",
"docName": "output.pdf",
"async": true
}
Esempi di codice
IL PDF4me Estrai i dati del modulo da PDF REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# Esempio (CSharp)
Completo C# implementazione per l'estrazione dei dati del modulo da PDF:
Java Campione
Java implementazione con gestione completa degli errori ed elaborazione delle risposte:
JavaScript Campione
Node.js e compatibile con i browser JavaScript implementazione:
Google Apps Script Campione
Google Apps Script implementazione per Google Workspace integrazione:
Funzionalità di estrazione dei dati dai moduli
Capacità di analisi sul campo
- Rilevamento completo del campo: Identificare tutti i campi del modulo, inclusi i campi nascosti e calcolati
- Estrazione di valore: Estrai i valori correnti e i valori predefiniti da tutti i tipi di campo
- Analisi immobiliareRecupera le proprietà dei campi, inclusi nomi, tipi, posizioni e regole di convalida.
- Validazione dei dati: Verificare l'integrità dei dati dei campi e la conformità del formato
Generazione di moduli
- PDF Analisi della forma: Analisi approfondita di PDF struttura della forma e relazioni di campo
- Riconoscimento del tipo di campo: Identificazione automatica dei vari tipi di campi del modulo
- Elaborazione in batch: Elabora più moduli ed estrai dati da strutture di moduli complesse
- Output strutturatoGenera dati organizzati e strutturati per una facile integrazione
Funzionalità avanzate
- Mappatura del campo: Mappa i campi del modulo alle colonne del database o ai campi dell'applicazione
- Trasformazione dei dati: Converti i dati del modulo in vari formati di output (JSON, XML, CSV)
- Regole di convalida: Estrarre e applicare le regole e i vincoli di validazione del modulo
- Risultati professionaliEstrazione di alta qualità adatta ad applicazioni aziendali
Casi d'uso e applicazioni industriali
- Document Management & Processing
- Business & Finance
- Legal & Compliance
- Healthcare & Medical
- Government & Public Sector
- Education & Research
Casi d'uso per la gestione e l'elaborazione dei documenti
- Raccolta dati tramite modulo: Estrai i dati dai campi compilati PDF moduli per l'archiviazione in database
- Digitalizzazione dei documenti: Convertire i moduli cartacei in dati digitali tramite PDF elaborazione
- Migrazione dei datiEstrazione dei dati dei moduli durante la migrazione dei documenti e gli aggiornamenti di sistema.
- Analisi della formaAnalizzare i tassi di completamento dei moduli e le modalità di utilizzo dei campi.
Casi d'uso in ambito aziendale e finanziario
- Elaborazione delle fattureEstrarre dati da moduli di fattura e ordini di acquisto
- Elaborazione delle applicazioniGestire le richieste di prestito, le richieste di risarcimento assicurativo e i moduli di registrazione.
- Dati del sondaggioEstrarre le risposte dai sondaggi e dai moduli di feedback dei clienti.
- Moduli di conformità: Elaborare i moduli di conformità normativa e i documenti fiscali
Casi d'uso legali e di conformità
- Moduli legaliEstrarre dati da documenti legali e moduli giudiziari
- Elaborazione contrattuale: Elaborazione dei moduli contrattuali e dei dati relativi agli accordi
- Conformità normativaEstrarre dati da moduli di conformità e documenti normativi
- Raccolta delle proveEstrazione dei dati del modulo per prove e documentazione legale
Casi d'uso in ambito sanitario e medico
- Moduli per i pazientiEstrarre i dati dai moduli di registrazione del paziente e dall'anamnesi medica.
- richieste di risarcimento assicurativo: Elaborare i moduli di richiesta di rimborso assicurativo e i documenti di fatturazione medica
- Studi cliniciEstrarre dati dai moduli di ricerca e dai documenti degli studi clinici.
- Cartelle cliniche: Elaborare i moduli medici e i documenti informativi dei pazienti
Casi d'uso nel settore pubblico e governativo
- Servizi ai cittadiniEstrarre dati da moduli governativi e domande dei cittadini
- Elaborazione delle imposte: Elaborare i moduli fiscali e i documenti di dichiarazione finanziaria
- Richieste di autorizzazioneEstrarre i dati dai moduli di richiesta di permessi e licenze
- Registri pubblici: Elaborare i registri pubblici e i documenti ufficiali governativi
Casi d'uso in ambito educativo e di ricerca.
- Moduli per studentiEstrarre dati dai moduli di iscrizione e dalle domande di ammissione ai corsi di studio.
- Dati di ricerca: Elaborare i moduli di ricerca e le risposte ai sondaggi
- Moduli di valutazioneEstrarre i dati dai moduli di valutazione e accertamento
- Moduli amministrativi: Elaborare moduli amministrativi e documenti istituzionali