Générer un document unique
Générer → Générer un document unique
Le Générer un document unique API génère un document à partir d'un modèle et de données. Vous envoyez le modèle (templateFileType, templateFileName, templateFileData Base64), documentDataType (texte, JSON, XML), outputType (html, PDF, Word, Excel), documentDataText ou documentDataFile, facultatif fileMetaData et metaDataJson, et async. Le API renvoie le document généré (binaire ou par interrogation) URLUtilisez l'outil de test ci-dessous pour l'essayer ; vous trouverez plus de détails dans les sections suivantes.
Essayez la fonction Générer un document unique API
Point final : POST /api/v2/GenerateDocumentSingle · Requis: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
Utilisez le formulaire ci-dessous pour envoyer votre API clé, fichier modèle (Base64), type de données, type de sortie et données (JSON/XML (texte ou fichier). La réponse est le document généré. Aucun code requis, remplissez les champs et cliquez Envoyer une requête.
Aperçu, paramètres et cas d'utilisation
- Overview
- Parameters
- Use cases
Qu'est-ce que la génération de document unique ?
Ce point de terminaison génère un document unique à partir d'un modèle (Word, HTML, ou PDF) et données (JSON ou XML). Vous fournissez le fichier modèle (Base64), templateFileType et templateFileName, documentDataType (texte, JSON, XML), outputType (html, PDF, Word, Excel), et les données via documentDataText ou documentDataFile. Le API Fusionne les données dans le modèle et renvoie le document généré. Utilisation facultative fileMetaData et metaDataJson pour des métadonnées supplémentaires.
Caractéristiques principales
- Types de modèles: Mot, HTML, ou PDF modèles (Base64).
- Données: documentDataType: texte, JSON, ou XML; données dans documentDataText ou documentDataFile (Base64).
- Sortir: outputType: html, PDF, Word ou Excel.
- Asynchrone: Utiliser async pour les modèles ou les données volumineuses.
Conseil : Idéal pour
À utiliser lorsque vous avez besoin d'un document par appel (factures, lettres, rapports). Pour plusieurs documents à partir d'un seul modèle, utilisez Générer plusieurs documents.
:::
API paramètres
| Paramètre | Taper | Requis | Description |
|---|---|---|---|
| api-key | chaîne | Oui | Ton PDF4me API clé, Base64 encodé. Obtenez-le depuis le tableau de bord. |
| templateFileType | chaîne | Oui | HTML, Word, PDF, HTML, ou DOCX. |
| templateFileName | chaîne | Oui | Nom du fichier modèle avec son extension (par exemple, invoice_template.html). |
| templateFileData | base64 | Oui | Contenu du fichier modèle (Base64). |
| documentDataType | chaîne | Oui | texte, JSON, ou XML. |
| outputType | chaîne | Oui | html, PDF, Word, Excel ou HTML. |
| documentDataText | chaîne | Oui | JSON/XML données sous forme de texte (si documentDataFile non fourni). |
| documentDataFile | base64 | Non | Fichier de données (Base64), alternative à documentDataText. |
| fileMetaData, metaDataJson | chaîne | Non | Métadonnées supplémentaires. |
| async | booléen | Non | Activer le traitement asynchrone. |
Quand utiliser Générer un document unique
- Factures et lettresGénérer un document par modèle (facture, contrat, lettre) avec des données fusionnées.
- RapportsGénérer un rapport unique à partir d'un modèle et JSON/XML données.
- CertificatsGénérer un certificat ou un document par appel.
Pour les schémas de requête/réponse et des exemples de code, voir Générer un document unique dans le PDF4me API documents.
Prérequis
Avant d'utiliser ce point de terminaison, assurez-vous d'avoir :
- Un valide PDF4me API clé (Obtenez votre API Clé)
- Un fichier modèle (Word, HTML, ou PDF) dans Base64 format
- Données dans JSON ou XML format
Format de réponse
Le API renvoie le document généré sous forme de données binaires pour un traitement synchrone (200 OK) ou fournit un sondage URL pour le traitement asynchrone (202 Accepted).