Formularfelder zu PDF hinzufügen – Interaktive Formular-API
PDF4me Formularfelder zu PDF hinzufügen ermöglicht es Ihnen, interaktive Formularfelder hinzuzufügen PDF Dokumente. Diese API Serviceprozesse PDF Dateien und fügt Formularfelder (Textfelder und Kontrollkästchen) an bestimmten Positionen auf bestimmten Seiten hinzu. API empfängt PDF Inhalts- und Formularfeldparameter über REST API Anrufe, die genutzt werden Base64 Sichere Datenübertragung durch Verschlüsselung. Dank flexibler Positionierung, benutzerdefinierter Feldtypen und Seitenausrichtung eignet sich diese Lösung ideal für die Dokumentenautomatisierung und interaktive Anwendungen. PDF Entwicklungs-Workflows.
Authentifizierung Ihrer API-Anfrage
Um auf die PDF4me REST APIJede Anfrage muss die entsprechenden Authentifizierungsdaten enthalten. Die Authentifizierung gewährleistet eine sichere Kommunikation und bestätigt Ihre Identität als autorisierter Benutzer des Systems. REST APIDie
Hauptmerkmale
- Formularfeldtypen: Fügen Sie TextBox- und CheckBox-Formularfelder hinzu PDF Dokumente
- Präzise Positionierung: Feldplatzierung mit exakten X- und Y-Koordinaten steuern
- Benutzerdefinierte Feldgrößen: Passen Sie die Abmessungen der Formularfelder an die Designanforderungen an.
- Flexibles Seiten-Targeting: Formularfelder bestimmten Seiten oder ganzen Dokumenten zuweisen
- Anfangswerte: Standardwerte für Formularfelder festlegen
- Base64 Kodierung: Sichere Übertragung von Dateiinhalten mithilfe von Base64 Kodierung
- Einfach API IntegrationRESTful API entwickelt für automatisierte PDF Workflows zur Formularerstellung
REST-API-Endpunkt
Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Formularfeld-Hinzufügungsoperationen werden über einen einzigen Endpunkt durchgeführt:
- Verfahren: POST
- Endpunkt:
/api/v2/AddFormField
REST-API-Parameter
Vollständige Liste der Parameter für das Hinzufügen von Formularfeldern zu PDF REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.
Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind erforderlich und müssen angegeben werden. API um ordnungsgemäß zu funktionieren.
Erforderliche Parameter
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| docContent* | Base64 | Der Inhalt der Eingabe PDF Datei kodiert in Base64 | JVBERi... |
| docName* | String | Quelle PDF Dateiname mit der Erweiterung .pdf | output.pdf |
| Anfangswert* | String | Anfangswert für das Formularfeld | New input text |
| positionX* | Integer | X-Position des Formularfelds auf der Seite | 300 |
| Position Y* | Integer | Y-Position des Formularfelds auf der Seite | 300 |
| Feldname* | String | Name des Formularfelds | Input Field Name |
| Größe* | Integer | Größe des Formularfelds | 4 |
| Seiten* | String | Seitenoptionen: „1“ für Seite 1, „1, 3, 5“ für bestimmte Seiten, „2–5“ für einen Seitenbereich, „1, 3, 7–10“ für gemischte Seiten, „1–“ für Seiten von 1 bis zum Ende | 1 |
| Formularfeldtyp* | String | Formularfeldtyp: TextBox oder Kontrollkästchen | TextBox |
Optionale Parameter
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| asynchron | Boolean | Aktivieren Sie die asynchrone Verarbeitung. Wenn true, Die API Gibt den Statuscode 202 zurück und stellt eine Abfrage bereit. URL im Location-Header | true |
Ausgabe
Der PDF4me Formularfelder zu PDF hinzufügen REST API Die Antwort hängt vom Verarbeitungsmodus ab. API gibt zurück PDF als Binärdaten zur synchronen Verarbeitung oder bietet eine Abfragefunktion URL für die asynchrone Verarbeitung.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Synchrone Verarbeitung (Standard)
Wann async ist nicht festgelegt oder auf gesetzt false, Die API verarbeitet die Anfrage sofort:
Statuscode: 200 OK
Inhaltstyp: application/pdf oder application/octet-stream
Antworttext:
Der API gibt zurück PDF Datei direkt als Binärdaten (nicht JSON).
Anwendungshinweise:
- Der Antworttext enthält die Binärdaten. PDF Daten
- Speichern Sie den Antwortinhalt direkt als PDF Datei
- NEIN Base64 Für binäre Antworten ist eine Dekodierung erforderlich.
Beispiel (JavaScript):
const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly
Asynchrone Verarbeitung
Wann async: true ist festgelegt, die API verarbeitet die Anfrage asynchron:
Statuscode: 202 Accepted
Antwort-Header:
Location: https://api.pdf4me.com/api/v2/AddFormField/poll/12345-abcde-67890
Abstimmungsverfahren:
- Extrahieren Sie die
LocationHeader der 202-Antwort - Befragen Sie die URL Verwendung GET Anfragen
- Nehmen Sie so lange an der Umfrage teil, bis Sie eine Antwort erhalten. 200 OK Status
- Die endgültige Antwort enthält das Binärsystem. PDF Daten
Umfragebeispiel:
// 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
}
Fehlermeldungen
| Statuscode | Beschreibung | Beispielantwort |
|---|---|---|
| 400 Bad Request | Ungültige Anfrageparameter oder fehlende Pflichtfelder | {"error": "Missing required parameter: fieldName"} |
| 401 Unauthorized | Ungültig oder fehlend API Schlüssel | {"error": "Unauthorized"} |
| 500 Internal Server Error | Serverfehler während der Verarbeitung | {"error": "Internal server error"} |
Die Antwort verstehen
- Synchron (200)Gibt Binärdaten zurück PDF Daten direkt
- Asynchron (202)Gibt den Location-Header für das Polling zurück; die endgültige Antwort ist binär. PDF
- NEIN JSON Verpackung: Der API Rückgaben PDF als Binärdaten, nicht verpackt in JSON mit Base64 Kodierung
Beispielanfrage
Kopfzeile
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Notiz: Der API Der Schlüssel muss sein Base64 kodiert. Holen Sie sich Ihre API Schlüssel vom PDF4me Armaturenbrett
Nutzlast
{
"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"
}
Codebeispiele
Der PDF4me Formularfelder zu PDF hinzufügen REST API Es werden Codebeispiele in verschiedenen Programmiersprachen bereitgestellt. Wählen Sie die Sprache, die am besten zu Ihrer Entwicklungsumgebung passt:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Beispiel
Vollständig C# Implementierung zum Hinzufügen von Formularfeldern zu PDF:
Java Probe
Java Implementierung mit vollständiger Fehlerbehandlung und Antwortverarbeitung:
Python Probe
Python Implementierung mit der Requests-Bibliothek und JSON Handhabung:
Google Apps Script Probe
Google Apps Script Implementierung für Google Workspace Integration:
Funktionen zur Erstellung von Formularfeldern
Formularfeldtypen
- Textfeld: Texteingabefelder für die Dateneingabe durch Benutzer und das Ausfüllen von Formularen erstellen
- Kontrollkästchenfelder: Kontrollkästchen für Auswahl- und Bestätigungsoptionen hinzufügen
- Maßanfertigung: Passen Sie die Feldabmessungen an die Designanforderungen und Inhaltsanforderungen an.
- Professionelle ErgebnisseHochwertige Formularfelderstellung mit präziser Funktionalität
- Erweiterte VerarbeitungUnterstützung für komplexe Formularlayouts und Feldanordnungen
Positionierung und Layout
- Präzise Koordinaten: Feldplatzierung mit exakten X- und Y-Positionswerten steuern
- Flexible PositionierungUnterstützung für beliebige Seitenpositionen und Feldanordnungen
- Seitenausrichtung: Formularfelder bestimmten Seiten oder ganzen Dokumenten zuweisen
- Maßanfertigung: Anpassbare Feldabmessungen für optimale Formgestaltung
- Professionelles LayoutEinheitliche Platzierung der Formularfelder auf allen Zielseiten
Erweiterte Funktionen
- Anfangswerte: Standardfeldwerte für eine verbesserte Benutzerfreundlichkeit festlegen
- Feldbenennung: Benutzerdefinierte Feldnamen für die Formulardatenerfassung und -verarbeitung
- Professionelle ErstellungHochwertige Formularfeldgenerierung mit klarer Funktionalität
- Flexible OptionenAnpassbare Formularfeldparameter für spezifische Anforderungen
Branchenspezifische Anwendungsfälle und Anwendungen
- Legal & Professional Services
- Healthcare & Medical
- Finance & Banking
- Human Resources
- Business & Enterprise
Anwendungsfälle für Rechts- und Beratungsdienstleistungen
- Vertragsformulare: Formularfelder für digitale Signaturen zu Verträgen und Vereinbarungen hinzufügen
- RechtsdokumentationErstellung interaktiver Formulare für die Verarbeitung juristischer Dokumente
- KonformitätsformulareFormulare für die Einhaltung gesetzlicher Vorschriften und die Dokumentation erstellen
- KundenaufnahmeErstellung von Mandantenaufnahmeformularen für Rechtsdienstleistungen
Anwendungsfälle im Gesundheitswesen und in der Medizin
- Patientenformulare: Erstellung interaktiver Patientenaufnahme- und Krankengeschichteformulare
- Medizinische Dokumentation: Formulare für medizinische Aufzeichnungen und Dokumentation erstellen
- Versicherungsansprüche: Entwurfsformulare für die Bearbeitung von Versicherungsansprüchen
- Einwilligungsformulare: Erstellung von Einwilligungs- und Genehmigungsformularen für medizinische Eingriffe
Anwendungsfälle im Finanz- und Bankwesen
- Finanzanwendungen: Erstellen Sie Antragsformulare für Darlehen und Kredite
- Kontoeröffnung: Formulare für die Kontoeröffnung und KYC-Prozesse erstellen
- Transaktionsformulare: Entwurf von Formularen für Finanztransaktionen und deren Verarbeitung
- Konformitätsdokumentation: Formulare für die Berichterstattung zur Einhaltung gesetzlicher Vorschriften erstellen
Anwendungsfälle im Personalwesen
- Antragsbearbeitung: Erstellung von Antragsformularen für Stellenbewerbungen und Registrierungen
- Mitarbeiter-Onboarding: Formulare für die Einarbeitung und Dokumentation von Mitarbeitern erstellen
- Erstellung von Umfragen: Gestaltung interaktiver Umfragen und Fragebögen in PDF Format
- Leistungsbeurteilungen: Formulare für Leistungsbeurteilung und Feedback erstellen
Anwendungsfälle für Unternehmen und Organisationen
- Dokumentenautomatisierung: Erstellung interaktiver Formulare zur Datenerfassung und -verarbeitung
- Datenerfassung: Formulare zur Erfassung von Kundeninformationen und Feedback erstellen
- Interaktive Dokumente: Fügen Sie Formularfelder zu bestehenden Formularen hinzu PDFs zur Steigerung der Nutzerbindung
- Geschäftsprozessautomatisierung: Formulare für automatisierte Geschäftsprozesse und die Dateneingabe erstellen