Anhang hinzufügen PDF - Einbetten von Dateien API
PDF4me Anhang hinzufügen PDF ermöglicht es Ihnen, Dateianhänge hinzuzufügen PDF Dokumente, Erstellung umfassender Dokumentenpakete mit eingebetteten Dateien. API Serviceprozesse PDF Dokumente und verschiedene Dateitypen von Anhängen, die direkt eingebettet werden in PDFs. Der API empfängt Quelle PDF Dateien und Anhänge über REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Dateiübertragung. Dank Unterstützung mehrerer Dateitypen und Stapelverarbeitung von Anhängen ist diese Lösung ideal für Dokumentenmanagementsysteme, Unternehmens-Workflows und Geschäftsanwendungen, die zuverlässige Verschlüsselung erfordern. PDF Anhangsfunktion.
Authentifizierung Ihres 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
- Mehrere DateitypenUnterstützung für verschiedene Anhangsdateiformate, einschließlich Text, Bilder und Dokumente
- Stapelanhänge: Mehrere Anhänge zu einem einzelnen hinzufügen PDF dokumentieren
- Base64 Kodierung: Sichere Übertragung von Dateiinhalten mithilfe von Base64 Kodierung
- DokumentenerhaltungBehält das Original bei PDF Struktur beim Hinzufügen von Anhängen
- Flexible Namensgebung: Anhängenamen für eine bessere Organisation anpassen
- Professionelle Verpackung: Erstellen Sie umfassende Dokumentenpakete mit eingebetteten Ressourcen
REST API Endpunkt
Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Operationen zum Hinzufügen von Anhängen werden über einen einzigen Endpunkt durchgeführt:
- Verfahren: POST
- Endpunkt:
/api/v2/AddAttachmentToPdf
REST API Parameter
Vollständige Liste der Parameter für die Funktion "Anhang hinzufügen" 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 |
|---|---|---|---|
| docName* | String | Ausgabe PDF Dateiname mit der Erweiterung .pdf | output.pdf |
| docContent* | Base64 | Der Inhalt der Eingabe PDF Datei kodiert in Base64 | JVBERi... |
| Anhänge* | Array | Array von Anhangsobjekten, die in die PDFJedes Objekt muss Folgendes enthalten: docName (Zeichenkette) und docContent (Base64-Zeichenkette) | Siehe Beispiel unten |
Anhangobjektstruktur
Jeder Gegenstand im attachments Das Array muss ein Objekt mit folgender Struktur sein:
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| docName | String | Name der Anhangsdatei mit Dateiendung (z. B. .txt, .pdf, .jpg usw.) | attachment.txt |
| docContent | Base64 | Der Inhalt der angehängten Datei ist kodiert in Base64 | RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA== |
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 Überschrift | true |
Ausgabe
Der PDF4me Anhang hinzufügen PDF REST API Die Antwort hängt vom Verarbeitungsmodus ab. API gibt zurück PDF als Base64-kodierte Zeichenkette in JSON Format, nicht als Binärdaten.
- 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/json
Antworttext:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Antwortfelder:
- docName (Zeichenkette): Die Ausgabe PDF Dateiname
- docContent (Zeichenkette): Die PDF Datei mit eingebetteten Anhängen, kodiert als Base64 Zeichenkette
Anwendungshinweise:
- Extrahieren Sie die
docContentFeld vom JSON Antwort - Entschlüsseln Sie die Base64 Zeichenkette, um die Binärdatei zu erhalten PDF Daten
- Speichern oder verarbeiten Sie die PDF Datei nach Bedarf
Beispiel (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Asynchrone Verarbeitung
Wann async: true ist festgelegt, die API verarbeitet die Anfrage asynchron:
Statuscode: 202 akzeptiert
Antwort-Header:
Location: https://api.pdf4me.com/api/v2/AddAttachmentToPdf/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 dasselbe JSON Format mit
docNameUnddocContent(Base64)
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 data = await pollResponse.json();
// Process data.docContent (Base64 PDF)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
Fehlermeldungen
Der API Standard-Rückgabe HTTP Fehlercodes mit Fehlerdetails:
- Ungültige Anfrageparameter
- Fehlende Pflichtfelder (
docName,docContent,Anhänge) - Ungültig Base64 Kodierung in
docContentoder AnhangdocContent - Ungültige Anhangsobjektstruktur
- Ungültig oder fehlend API Schlüssel
- API Schlüssel nicht richtig Base64 kodiert in Authorization Überschrift
- Fehlen
Autorisierung: BasisÜberschrift
- Serverseitiger Verarbeitungsfehler
- PDF Verarbeitungsfehler
- Fehler bei der Einbettung des Anbauteils
Fehlerantwortformat:
{
"error": "Error message describing what went wrong"
}
Details zum Antwortformat
Wichtig: Der API kehrt immer zurück JSONniemals binär PDF Daten direkt.
Antwortstruktur:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type-Header:
- Erfolg:
application/json - Der PDF ist eingebettet als Base64 Zeichenkette innerhalb der JSON Antwort
Warum Base64?
- JSON-sichere Kodierung für Binärdaten
- Einfach zu übertragen über HTTP
- Kompatibel mit allen Programmiersprachen
- Kann direkt eingebettet werden in JSON ohne den Problemen auszuweichen
Dekodierung Base64 Zu PDF:
JavaScript/Node.js:
const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js
Python:
import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
f.write(pdf_bytes)
C#:
byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);
Beispielanfrage
Kopfzeile
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Notiz:
- Hol dir deins API Schlüssel vom PDF4me Armaturenbrett
- Der API Der Schlüssel muss sein Base64 kodiert und mit "Basic" präfixiert in der Authorization Überschrift
- Beispiel: Wenn Ihr API Schlüssel ist
abc123, kodieren Sie es zu Base64 und verwendenAuthorization: Basic YWJjMTIz
Nutzlast
Einzelner Anhang:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "output.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
}
]
}
Mehrere Anhänge:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "file1.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
},
{
"docName": "file2.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MK..."
}
],
"async": true
}
Codebeispiele
Der PDF4me Anhang hinzufügen PDF 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
Java Probe
Java Implementierung mit vollständiger Fehlerbehandlung und Antwortverarbeitung:
Python Probe
Python Implementierung mit der Requests-Bibliothek und JSON Handhabung:
PDF Anbauteile
Anhangsverarbeitung
- Mehrere DateitypenUnterstützung für verschiedene Anhangsformate, darunter Textdateien (.txt, .csv, .log), Dokumente (.pdf, .doc, .docx, .xls, .xlsx), Bilder (.jpg, .jpeg, .png, .gif), Archive (.zip, .rar) und andere Dateitypen
- Stapelverarbeitung: Mehrere Anhänge zu einem einzelnen hinzufügen PDF Dokument in einem Arbeitsgang durch Bereitstellung eines Arrays von Anhangsobjekten
- Base64 Kodierung: Sichere Übertragung von Dateiinhalten mittels Base64 Kodierung
- DateibenennungJeder Anhang muss Folgendes enthalten:
docNamemit der entsprechenden Dateierweiterung
Dokumentenoptimierung
- PDF KonservierungBehält das Original bei PDF Struktur und Inhalt beim Hinzufügen von Anhängen
- Dateiorganisation: Benutzerdefinierte Benennung und Organisation eingebetteter Anhänge durch die
docNameFeld - Dokumentenportabilität: Erstellen Sie in sich abgeschlossene Dokumentpakete, in denen alle zugehörigen Dateien eingebettet sind. PDF
- Professionelle Verpackung: Erstellung umfassender Dokumentenpakete zur Verteilung
Bearbeitung von Anfragen
- Synchrone VerarbeitungStandardmäßig ist die API verarbeitet Anfragen synchron und gibt das Ergebnis zurück. PDF mit Anhängen (Status 200)
- Asynchrone Verarbeitung: Satz
async: trueum die asynchrone Verarbeitung zu ermöglichen. API Gibt bei einer Abfrage den Statuscode 202 zurück. URL im Location Überschrift - Binäre Antwort: Der API gibt zurück PDF Datei als Binärinhalt (application/pdf) speichern, wenn erfolgreich
Branchenspezifische Anwendungsfälle und Anwendungen
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Technology & Development
Anwendungsfälle für Rechts- und Beratungsdienstleistungen
- RechtsdokumentationFügen Sie Beweismittel, Verträge und Belege bei.
- Gerichtsdokumente: Fügen Sie den Gerichtsdokumenten und Schriftsätzen unterstützende Unterlagen bei.
- Kundendokumentation: Kundendokumente mit Begleitmaterialien zusammenstellen
- Konformitätsdokumentation: Fügen Sie Zertifikate, Lizenzen und behördliche Dokumente bei.
Anwendungsfälle in Bildung und Forschung
- Wissenschaftliche Arbeiten: Datensätze, Forschungsmaterialien und ergänzende Informationen einbeziehen
- Forschungsdokumentation: Forschungsdaten und ergänzende Materialien beifügen
- Einreichung von Abschlussarbeiten: Verpacken Sie Ihre Abschlussarbeiten mit unterstützenden Dokumenten und Datensätzen
- Schulungsmaterialien: Ressourcen, Übungen und Referenzhandbücher einbetten
Anwendungsfälle für Unternehmen und Organisationen
- GeschäftsberichteFügen Sie Tabellenkalkulationen, Diagramme und detaillierte Analysedateien bei.
- Projektergebnisse: Alle Projektdateien in einem einzigen PDF-Dokument zusammenfassen
- Dokumentenpakete: Erstellung umfassender Dokumentenpakete mit Begleitmaterialien
- UnternehmensdokumentationFügen Sie den Unternehmensdokumenten unterstützende Materialien bei.
Anwendungsfälle für Technologie und Entwicklung
- Technische Dokumentation: Einbettungscodebeispiele, Konfigurationsdateien und Referenzmaterialien
- Softwaredokumentation: Fügen Sie Code-Dateien und technische Spezifikationen bei.
- API-Dokumentation: Codebeispiele und Konfigurationsdateien beifügen
- Entwicklerressourcen: Ressourcen und Referenzmaterialien für Paketentwickler