Aggiungi campi modulo al PDF - API per moduli interattivi
PDF4me Aggiungere campi modulo al PDF consente di aggiungere campi modulo interattivi a PDF documenti. Questo API processi di servizio PDF file e aggiunge campi modulo (caselle di testo e caselle di controllo) in posizioni specifiche su pagine specificate. API riceve PDF parametri dei campi di contenuto e modulo tramite REST API chiamate, utilizzando Base64 codifica per trasmissione sicura. Con supporto per posizionamento flessibile, tipi di campo personalizzati e targeting di pagina, questa soluzione è ideale per l'automazione dei documenti e interattiva PDF flussi di lavoro di sviluppo.
Autenticazione della richiesta API
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
- Tipi di campi del modulo: Aggiungi i campi modulo TextBox e CheckBox a PDF Documenti
- Posizionamento preciso: Posizionamento del campo di controllo con coordinate X e Y precise
- Dimensioni personalizzate dei campiRegola le dimensioni dei campi del modulo in modo che corrispondano ai requisiti di progettazione.
- Targeting flessibile delle pagine: Applicare i campi del modulo a pagine specifiche o a interi documenti
- Valori inizialiImposta i valori predefiniti per i campi del modulo
- Base64 Codifica: Trasmissione sicura del contenuto dei file tramite Base64 codifica
- Semplice API Integrazione: RESTful API progettato per l'automazione PDF flussi di lavoro per la creazione di moduli
Endpoint API REST
IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di aggiunta di campi del modulo vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
/api/v2/AddFormField
Parametri dell'API REST
Elenco completo dei parametri per Aggiungi campi modulo al 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 |
|---|---|---|---|
| docContent* | Base64 | Il contenuto dell'input PDF file codificato in Base64 | JVBERi... |
| docName* | String | Fonte PDF nome del file con estensione .pdf | output.pdf |
| valore iniziale* | String | Valore iniziale per il campo del modulo | New input text |
| posizioneX* | Integer | Posizione X del campo del modulo sulla pagina | 300 |
| posizioneY* | Integer | Posizione Y del campo del modulo sulla pagina | 300 |
| nomecampo* | String | Nome del campo del modulo | Input Field Name |
| Misurare* | Integer | Dimensione del campo del modulo | 4 |
| pagine* | String | Opzioni pagina: "1" per la pagina 1, "1,3,5" per pagine specifiche, "2-5" per intervallo di pagine, "1,3,7-10" per pagine miste, "1-" per pagine da 1 a fine | 1 |
| formFieldType* | String | Tipo di campo del modulo: Casella di testo O Casella di controllo | TextBox |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| asincrono | Boolean | Abilita l'elaborazione asincrona. Quando true, IL API restituisce uno stato 202 e fornisce un polling URL nell'intestazione Posizione | true |
Produzione
IL PDF4me Aggiungere campi modulo al PDF REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il PDF COME dati binari per l'elaborazione sincrona o fornisce un polling URL per l'elaborazione asincrona.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Elaborazione sincrona (impostazione predefinita)
Quando async non è impostato o impostato su false, IL API elabora la richiesta immediatamente:
Codice di stato: 200 OK
Tipo di contenuto: application/pdf O application/octet-stream
Corpo della risposta:
IL API restituisce il PDF file direttamente come dati binari (non JSON).
Come si usa:
- Il corpo della risposta contiene il binario PDF dati
- Salva il contenuto della risposta direttamente come PDF file
- NO Base64 La decodifica è necessaria per le risposte binarie
Esempio (JavaScript):
const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly
Elaborazione asincrona
Quando async: true è impostato, il API elabora la richiesta in modo asincrono:
Codice di stato: 202 Accepted
Intestazioni di risposta:
Location: https://api.pdf4me.com/api/v2/AddFormField/poll/12345-abcde-67890
Procedura di votazione:
- Estrarre il
Locationintestazione dalla risposta 202 - Sondare il URL utilizzando GET richieste
- Continua a fare sondaggi finché non ricevi un 200 OK stati
- La risposta finale contiene il binario PDF dati
Esempio di sondaggio:
// 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
}
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: fieldName"} |
| 401 Unauthorized | Non valido o mancante API chiave | {"error": "Unauthorized"} |
| 500 Internal Server Error | Errore del server durante l'elaborazione | {"error": "Internal server error"} |
Comprensione della risposta
- Sincrono (200): Restituisce valori binari PDF dati direttamente
- Asincrono (202): Restituisce l'intestazione Location per il polling, la risposta finale è binaria PDF
- NO JSON Involucro: IL API resi PDF come binario, non avvolto in JSON con Base64 codifica
Esempio di richiesta
Intestazione
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota: IL API la chiave deve essere Base64 codificato. Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
Carico 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"
}
Esempi di codice
IL PDF4me Aggiungere campi modulo al 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
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 creazione dei campi modulo
Tipi di campi del modulo
- Campi della casella di testo: Creare campi di testo per l'inserimento dei dati dell'utente e il completamento dei moduli
- Campi CheckBox: Aggiungi elementi checkbox per opzioni di selezione e conferma
- Dimensioni personalizzate: Regola le dimensioni del campo per adattarle ai requisiti di progettazione e alle esigenze di contenuto
- Risultati professionaliCreazione di campi modulo di alta qualità con funzionalità accurate.
- Elaborazione avanzataSupporto per layout di moduli complessi e disposizioni dei campi
Posizionamento e disposizione
- coordinate precise: Controllo del posizionamento del campo con valori di posizione X e Y precisi
- Posizionamento flessibileSupporto per qualsiasi posizione di pagina e disposizione dei campi
- Targeting della pagina: Applicare i campi del modulo a pagine specifiche o a interi documenti
- Dimensioni personalizzate: Dimensioni del campo regolabili per una progettazione ottimale della forma
- Impaginazione professionalePosizionamento coerente dei campi del modulo su tutte le pagine di destinazione
Funzionalità avanzate
- Valori inizialiImposta i valori predefiniti dei campi per una migliore esperienza utente.
- Denominazione dei campi: Nomi di campi personalizzati per la raccolta e l'elaborazione dei dati dei moduli
- Creazione professionaleGenerazione di campi modulo di alta qualità con funzionalità chiare.
- Opzioni flessibiliParametri dei campi del modulo personalizzabili per esigenze specifiche
Casi d'uso e applicazioni industriali
- Legal & Professional Services
- Healthcare & Medical
- Finance & Banking
- Human Resources
- Business & Enterprise
Casi d'uso per servizi legali e professionali
- Moduli contrattualiAggiungi campi modulo a contratti e accordi per le firme digitali
- Documentazione legale: Creare moduli interattivi per l'elaborazione di documenti legali
- Moduli di conformità: Creare moduli per la conformità normativa e la documentazione
- Acquisizione del cliente: Creare moduli di acquisizione clienti per servizi legali
Casi d'uso in ambito sanitario e medico
- Moduli per i pazienti: Creare moduli interattivi per l'anamnesi e la raccolta della storia clinica del paziente
- Documentazione medica: Creare moduli per cartelle cliniche e documentazione
- richieste di risarcimento assicurativo: Progettazione di moduli per l'elaborazione delle richieste di risarcimento assicurativo
- Moduli di consenso: Creare moduli di consenso e autorizzazione per le procedure mediche
Casi d'uso in ambito finanziario e bancario
- Applicazioni finanziarie: Creare moduli di richiesta di prestito e credito
- Apertura conto: Creare moduli per l'apertura del conto e le procedure KYC
- Moduli di transazione: Progettazione di moduli per transazioni e processi finanziari
- Documentazione di conformità: Creare moduli per la rendicontazione della conformità normativa
Casi d'uso delle risorse umane
- Elaborazione delle applicazioni: Creare moduli di domanda per candidature e registrazioni di lavoro
- Onboarding dei dipendenti: Creare moduli per l'inserimento e la documentazione dei dipendenti
- Creazione di sondaggi: Progettare sondaggi e questionari interattivi in PDF formato
- Analisi delle prestazioni: Creare moduli per la valutazione delle prestazioni e il feedback
Casi d'uso aziendali e per le imprese
- Automazione dei dati: Creare moduli interattivi per la raccolta e l'elaborazione dei dati
- Raccolta dati: Creare moduli per la raccolta di informazioni e feedback dai clienti
- Documenti interattivi: Aggiungi campi modulo a quelli esistenti PDFs per un maggiore coinvolgimento degli utenti
- Automazione dei processi aziendali: Creare moduli per flussi di lavoro aziendali automatizzati e inserimento dati