Ajouter une pièce jointe à PDF - Intégration de fichiers API
PDF4me Ajouter une pièce jointe à PDF vous permet d'ajouter des pièces jointes à PDF documents, création de packages documentaires complets avec fichiers intégrés. API processus de service PDF documents et divers types de fichiers joints, en les intégrant directement dans PDFs. Le API reçoit la source PDF fichiers et pièces jointes via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée des fichiers. Prenant en charge de nombreux types de fichiers et le traitement par lots des pièces jointes, cette solution est idéale pour les systèmes de gestion documentaire, les flux de travail d'entreprise et les applications métier exigeant une transmission fiable. PDF Fonctionnalité de pièce jointe.
Authentification de votre API Demande
Pour accéder au PDF4me REST APIChaque requête doit inclure des informations d'authentification valides. L'authentification garantit la sécurité des communications et confirme votre identité en tant qu'utilisateur autorisé. REST API.
Caractéristiques principales
- Plusieurs types de fichiersPrise en charge de divers formats de fichiers joints, notamment le texte, les images et les documents.
- Pièces jointes par lots: Ajouter plusieurs pièces jointes à un seul PDF document
- Base64 Encodage: Sécuriser la transmission du contenu des fichiers à l'aide de Base64 encodage
- Préservation des documents: Conserve l'original PDF structure lors de l'ajout de pièces jointes
- Nommage flexiblePersonnalisez les noms des pièces jointes pour une meilleure organisation.
- Emballage professionnelCréer des ensembles de documents complets avec des ressources intégrées
REST API Point de terminaison
Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations d'ajout de pièces jointes sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
/api/v2/AddAttachmentToPdf
REST API Paramètres
Liste complète des paramètres pour l'ajout d'une pièce jointe à PDF REST APILes paramètres sont organisés par catégorie pour une meilleure compréhension et une mise en œuvre plus aisée.
Important: Les paramètres marqués d'un astérisque (*) sont obligatoires et doivent être fournis pour le API pour fonctionner correctement.
Paramètres requis
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| Nom du document* | String | Sortir PDF Nom de fichier avec l'extension .pdf | output.pdf |
| docContent* | Base64 | Le contenu de l'entrée PDF fichier encodé en Base64 | JVBERi... |
| pièces jointes* | Array | Tableau d'objets de pièce jointe à intégrer dans le PDFChaque objet doit contenir docName (chaîne de caractères) et docContent (chaîne de caractères en base64) | Voir l'exemple ci-dessous |
Structure de l'objet de pièce jointe
Chaque élément du attachments Le tableau doit être un objet ayant la structure suivante :
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| Nom du document | String | Nom du fichier joint avec son extension (par exemple, .txt, .pdf, .jpg, etc.) | attachment.txt |
| docContent | Base64 | Le contenu du fichier joint encodé en Base64 | RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA== |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| asynchrone | Boolean | Activer le traitement asynchrone. Lorsque true, le API renvoie un statut 202 et fournit un système d'interrogation URL dans le Location en-tête | true |
Sortir
Le PDF4me Ajouter une pièce jointe à PDF REST API renvoie des réponses différentes selon le mode de traitement. API renvoie le PDF comme un Base64chaîne encodée dans JSON format, et non sous forme de données binaires.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Traitement synchrone (par défaut)
Quand async n'est pas défini ou est défini sur false, le API traite la demande immédiatement :
Code d'état : 200 OK
Type de contenu : application/json
Corps de la réponse :
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Champs de réponse :
- Nom du document (chaîne de caractères) : La sortie PDF nom de fichier
- docContent (chaîne de caractères) : Le PDF fichier avec pièces jointes intégrées, encodé comme Base64 chaîne
Mode d'emploi :
- Extraire le
docContentchamp du JSON réponse - Décodez le Base64 chaîne permettant d'obtenir le binaire PDF données
- Enregistrer ou traiter le PDF classer selon les besoins
Exemple (JavaScript) :
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Traitement asynchrone
Quand async: true est réglé, le API traite la requête de manière asynchrone :
Code d'état : 202 Acceptés
En-têtes de réponse :
Location: https://api.pdf4me.com/api/v2/AddAttachmentToPdf/poll/12345-abcde-67890
Processus de sondage :
- Extraire le
LocationEn-tête de la réponse 202 - Sondage URL en utilisant GET demandes
- Continuez à sonder jusqu'à ce que vous receviez un 200 OK statut
- La réponse finale contient la même chose JSON format avec
docNameetdocContent(Base64)
Exemple de sondage :
// 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
}
Réponses d'erreur
Le API retours standard HTTP codes d'erreur avec détails de l'erreur :
- Paramètres de requête invalides
- Champs obligatoires manquants (
Nom du document,docContent,pièces jointes) - Invalide Base64 encodage dans
docContentou accessoiredocContent - Structure de l'objet de pièce jointe non valide
- Invalide ou manquant API clé
- API clé non correctement Base64 encodé dans Authorization en-tête
- Manquant
Autorisation : de baseen-tête
- Erreur de traitement côté serveur
- PDF échec du traitement
- Échec de l'intégration de la pièce jointe
Format de réponse en cas d'erreur :
{
"error": "Error message describing what went wrong"
}
Détails du format de réponse
Important: Le API toujours retourne JSON, jamais binaire PDF données directement.
Structure de la réponse :
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
En-tête Content-Type :
- Succès:
application/json - Le PDF est intégré en tant que Base64 chaîne à l'intérieur de la JSON réponse
Pourquoi Base64?
- JSON-codage sûr pour les données binaires
- Facile à transmettre sur HTTP
- Compatible avec tous les langages de programmation
- Peut être directement intégré dans JSON sans échapper aux problèmes
Décodage Base64 à 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);
Exemple de requête
En-tête
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Note:
- Obtenez votre API clé de la PDF4me Tableau de bord
- Le API La clé doit être Base64 encodé et préfixé par « Basic » dans le Authorization en-tête
- Exemple : Si votre API La clé est
abc123, encodez-le en Base64 et utiliserAuthorization: Basic YWJjMTIz
Charge utile
Pièce jointe unique :
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "output.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
}
]
}
Pièces jointes multiples :
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "file1.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
},
{
"docName": "file2.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MK..."
}
],
"async": true
}
Exemples de code
Le PDF4me Ajouter une pièce jointe à PDF REST API propose des exemples de code dans plusieurs langages de programmation. Choisissez le langage qui convient le mieux à votre environnement de développement :
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Échantillon
Complet C# implémentation pour l'ajout de pièces jointes à PDF:
Java Échantillon
Java implémentation avec gestion complète des erreurs et traitement des réponses :
JavaScript Échantillon
Node.js et compatible avec les navigateurs JavaScript mise en œuvre:
Python Échantillon
Python implémentation avec la bibliothèque requests et JSON manutention:
Google Script Échantillon
Google Apps Script implémentation avec UrlFetchApp :
AWS Lambda Échantillon
AWS Lambda mise en œuvre avec Node.js et API Passerelle :
PDF Caractéristiques des accessoires
Traitement des pièces jointes
- Plusieurs types de fichiersPrise en charge de divers formats de pièces jointes, notamment les fichiers texte (.txt, .csv, .log), les documents (.pdf, .doc, .docx, .xls, .xlsx), les images (.jpg, .jpeg, .png, .gif), les archives (.zip, .rar) et d'autres types de fichiers.
- Traitement par lots: Ajouter plusieurs pièces jointes à un seul PDF document en une seule opération en fournissant un tableau d'objets de pièce jointe
- Base64 Encodage: Transmission sécurisée du contenu des fichiers à l'aide de Base64 encodage
- Nommer les fichiersChaque pièce jointe doit inclure un
docNameavec l'extension de fichier appropriée
Amélioration des documents
- PDF Préservation: Conserve l'original PDF structure et contenu lors de l'ajout de pièces jointes
- Organisation des fichiers: Nommage et organisation personnalisés des pièces jointes intégrées via
docNamechamp - Portabilité des documents: Créer des packages de documents autonomes contenant tous les fichiers associés intégrés dans le PDF
- Emballage professionnelGénérer des ensembles de documents complets pour la distribution
Gestion des réponses
- Traitement synchronePar défaut, le API traite les requêtes de manière synchrone et renvoie le PDF avec pièces jointes (statut 200)
- Traitement asynchrone: Ensemble
async: truepour permettre le traitement asynchrone. API renvoie un statut 202 avec une interrogation URL dans le Location en-tête - Réponse binaire: Le API renvoie le PDF fichier sous forme de contenu binaire (application/pdf) en cas de succès
Cas d'utilisation et applications industrielles
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Technology & Development
Cas d'utilisation des services juridiques et professionnels
- Documentation juridique: Inclure les dossiers de preuves, les contrats et les documents justificatifs
- Documents déposés auprès du tribunal: Joindre les pièces justificatives aux documents déposés auprès du tribunal et aux mémoires juridiques
- Documentation client: Conditionner les documents du client avec les pièces justificatives
- Documentation de conformitéInclure les certificats, les licences et les documents réglementaires
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Articles académiquesInclure les ensembles de données, les documents de recherche et les informations complémentaires
- Documentation de rechercheJoindre les données de recherche et les documents complémentaires
- Soumissions de thèses: Fournir les thèses accompagnées des documents et jeux de données justificatifs
- Matériel de formationIntégrez des ressources, des exercices et des guides de référence.
Cas d'utilisation en entreprise
- Rapports d'entrepriseJoignez des feuilles de calcul, des graphiques et des fichiers d'analyse détaillés.
- Livrables du projet: Regrouper tous les fichiers du projet dans un seul document PDF
- Paquets de documentsCréer des dossiers documentaires complets avec des pièces justificatives.
- Documentation d'entreprise: Joindre les pièces justificatives aux documents de l'entreprise
Cas d'utilisation en matière de technologie et de développement
- Documentation technique: Exemples de code à intégrer, fichiers de configuration et documents de référence
- Documentation logicielleJoindre les fichiers de code et les spécifications techniques
- Documentation de l'APIInclure des exemples de code et des fichiers de configuration
- Ressources pour les développeursRessources et documents de référence pour les développeurs de packages