Aller au contenu principal

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.

Articles de blog connexes
Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.
En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.
Consultez le blog

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ètreTaperDescriptionExemple
Nom du document*StringSortir PDF Nom de fichier avec l'extension .pdfoutput.pdf
docContent*Base64Le contenu de l'entrée PDF fichier encodé en Base64JVBERi...
pièces jointes*ArrayTableau 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ètreTaperDescriptionExemple
Nom du documentStringNom du fichier joint avec son extension (par exemple, .txt, .pdf, .jpg, etc.)attachment.txt
docContentBase64Le contenu du fichier joint encodé en Base64RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA==

Paramètres optionnels

ParamètreTaperDescriptionExemple
asynchroneBooleanActiver le traitement asynchrone. Lorsque true, le API renvoie un statut 202 et fournit un système d'interrogation URL dans le Location en-têtetrue

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.

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 :

  1. Extraire le docContent champ du JSON réponse
  2. Décodez le Base64 chaîne permettant d'obtenir le binaire PDF données
  3. 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

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 utiliser Authorization: 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# (CSharp) Échantillon

Complet C# implémentation pour l'ajout de pièces jointes à PDF:

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 docName avec 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 docName champ
  • 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: true pour 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

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

Obtenez de l'aide