Aggiungi allegato a PDF - Incorporamento di file API
PDF4me Aggiungi allegato a PDF consente di aggiungere allegati di file a PDF documenti, creando pacchetti di documenti completi con file incorporati. Questo API processi di servizio PDF documenti e vari tipi di file allegati, incorporandoli direttamente in PDFs. IL API riceve la fonte PDF file e file allegati tramite REST API chiamate, utilizzando Base64 Codifica per la trasmissione sicura dei file. Grazie al supporto di più tipi di file e all'elaborazione batch degli allegati, questa soluzione è ideale per sistemi di gestione documentale, flussi di lavoro aziendali e applicazioni aziendali che richiedono affidabilità. PDF funzionalità di allegato.
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
- Diversi tipi di fileSupporto per vari formati di file allegati, inclusi testo, immagini e documenti.
- Allegati in batch: Aggiungi più allegati a un singolo PDF documento
- Base64 Codifica: Trasmissione sicura del contenuto dei file tramite Base64 codifica
- Conservazione dei documenti: Mantiene l'originale PDF struttura durante l'aggiunta di allegati
- Denominazione flessibilePersonalizza i nomi degli allegati per una migliore organizzazione
- Imballaggio professionale: Creare pacchetti di documenti completi con risorse incorporate
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di aggiunta di allegati vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
/api/v2/AddAttachmentToPdf
REST API Parametri
Elenco completo dei parametri per Aggiungi allegato a 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 | Produzione PDF nome del file con estensione .pdf | output.pdf |
| docContent* | Base64 | Il contenuto dell'input PDF file codificato in Base64 | JVBERi... |
| allegati* | Array | Array di oggetti allegati da incorporare nel PDFOgni oggetto deve contenere docName (stringa) e docContent (stringa base64) | Vedi l'esempio qui sotto |
Struttura dell'oggetto allegato
Ogni elemento nel attachments L'array deve essere un oggetto con la seguente struttura:
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| docName | String | Nome del file allegato con estensione (ad esempio, .txt, .pdf, .jpg, ecc.) | attachment.txt |
| docContent | Base64 | Il contenuto del file allegato codificato in Base64 | RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA== |
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 nel Location intestazione | true |
Produzione
IL PDF4me Aggiungi allegato a PDF REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il PDF come Base64-stringa codificata in JSON formato, non come dati binari.
- 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/json
Corpo della risposta:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Campi di risposta:
- docName (stringa): L'output PDF nome del file
- docContent (stringa): La PDF file con allegati incorporati, codificato come Base64 corda
Come si usa:
- Estrarre il
docContentcampo dal JSON risposta - decodificare il Base64 stringa per ottenere il binario PDF dati
- Salva o elabora il PDF file secondo necessità
Esempio (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Elaborazione asincrona
Quando async: true è impostato, il API elabora la richiesta in modo asincrono:
Codice di stato: 202 Accettati
Intestazioni di risposta:
Location: https://api.pdf4me.com/api/v2/AddAttachmentToPdf/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 lo stesso JSON formato con
docNameEdocContentBase64)
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 data = await pollResponse.json();
// Process data.docContent (Base64 PDF)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
Risposte di errore
IL API resi standard HTTP Codici di errore con dettagli dell'errore:
- Parametri di richiesta non validi
- Campi obbligatori mancanti (
docName,docContent,allegati) - Non valido Base64 codifica in
docContento allegatodocContent - Struttura dell'oggetto di allegato non valida
- Non valido o mancante API chiave
- API chiave non corretta Base64 codificato in Authorization intestazione
- Mancante
Autorizzazione: Baseintestazione
- Errore di elaborazione lato server
- PDF errore di elaborazione
- Errore di incorporamento dell'allegato
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSONmai binario PDF dati direttamente.
Struttura della risposta:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Intestazione Content-Type:
- Successo:
application/json - IL PDF è incorporato come un Base64 stringa all'interno della JSON risposta
Perché Base64?
- JSON- codifica sicura per dati binari
- Facile da trasmettere HTTP
- Compatibile con tutti i linguaggi di programmazione
- Può essere incorporato direttamente in JSON senza sfuggire ai problemi
Codifica Base64 A 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);
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
Allegato singolo:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "output.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
}
]
}
Allegati multipli:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "file1.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
},
{
"docName": "file2.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MK..."
}
],
"async": true
}
Esempi di codice
IL PDF4me Aggiungi allegato a 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:
PDF Caratteristiche degli allegati
Elaborazione degli allegati
- Diversi tipi di fileSupporto per vari formati di allegati, inclusi file di testo (.txt, .csv, .log), documenti (.pdf, .doc, .docx, .xls, .xlsx), immagini (.jpg, .jpeg, .png, .gif), archivi (.zip, .rar) e altri tipi di file.
- Elaborazione in batch: Aggiungi più allegati a un singolo PDF documentare in un'unica operazione fornendo un array di oggetti allegati
- Base64 Codifica: Trasmissione sicura del contenuto del file utilizzando Base64 codifica
- Denominazione dei file: Ogni allegato deve includere un
docNamecon l'estensione di file appropriata
Miglioramento del documento
- PDF Conservazione: Mantiene l'originale PDF struttura e contenuto durante l'aggiunta di allegati
- Organizzazione dei file: Denominazione e organizzazione personalizzate degli allegati incorporati tramite
docNamecampo - Portabilità dei documenti: Creare pacchetti di documenti autonomi con tutti i file correlati incorporati nel PDF
- Imballaggio professionaleGenerare pacchetti di documenti completi per la distribuzione
Gestione delle risposte
- Elaborazione sincrona: Per impostazione predefinita, il API elabora le richieste in modo sincrono e restituisce il PDF con allegati (stato 200)
- Elaborazione asincrona: Impostato
async: trueper consentire l'elaborazione asincrona. API restituisce uno stato 202 con un polling URL nel Location intestazione - Risposta binaria: IL API restituisce il PDF file come contenuto binario (application/pdf) in caso di successo
Casi d'uso e applicazioni industriali
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Technology & Development
Casi d'uso per servizi legali e professionali
- Documentazione legale: Includere fascicoli probatori, contratti e documenti giustificativi
- Atti giudiziariAllegare i documenti giustificativi agli atti giudiziari e alle memorie legali.
- Documentazione per il cliente: Preparare la documentazione del cliente con i materiali di supporto
- Documentazione di conformità: Includere certificati, licenze e documenti normativi
Casi d'uso in ambito educativo e di ricerca.
- Articoli accademiciIncludere set di dati, materiali di ricerca e informazioni supplementari.
- Documentazione di ricercaAllegare i dati della ricerca e i materiali supplementari.
- Presentazione delle tesi: Allegare alla tesi la documentazione di supporto e i set di dati
- Materiale formativo: Incorpora risorse, esercizi e guide di riferimento
Casi d'uso aziendali e per le imprese
- Rapporti aziendaliAllegare fogli di calcolo, grafici e file di analisi dettagliati.
- Risultati attesi del progettoRaggruppare tutti i file del progetto in un unico documento PDF.
- Pacchetto di documentiCreare pacchetti di documenti completi con materiali di supporto
- Documentazione aziendale: Allegare la documentazione di supporto ai documenti aziendali
Casi d'uso in ambito tecnologico e di sviluppo
- Documentazione tecnica: Incorpora esempi di codice, file di configurazione e materiali di riferimento
- Documentazione del softwareAllegare i file del codice e le specifiche tecniche.
- Documentazione API: Includere esempi di codice e file di configurazione
- Risorse per sviluppatori: Risorse e materiali di riferimento per gli sviluppatori di pacchetti