Genera documento singolo
Generare → Genera documento singolo
IL Genera documento singolo API genera un documento da un modello e dai dati. Invii il modello (templateFileType, templateFileName, templateFileData Base64), documentDataType (testo, JSON, XML), outputType (html, PDF, Word, Excel), documentDataText O documentDataFile, facoltativo fileMetaData E metaDataJson, E async. IL API restituisce il documento generato (binario o polling) URLUtilizza il tester qui sotto per provarlo; maggiori dettagli sono disponibili nelle sezioni seguenti.
Prova a generare un singolo documento API
:::nota - Guida rapida
Punto finale: POST /api/v2/GenerateDocumentSingle · Necessario: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
:::
Usa il modulo sottostante per inviare il tuo API chiave, file modello (Base64), tipo di dati, tipo di output e dati (JSON/XML testo o file). La risposta è il documento generato. Non è richiesto alcun codice, basta compilare i campi e cliccare Invia richiesta.
Panoramica, parametri e casi d'uso
- Overview
- Parameters
- Use cases
Che cos'è la generazione di un singolo documento?
Questo endpoint genera un singolo documento da un modello (Word, HTML, O PDF) e dati (JSON O XML). Fornisci il file modello (Base64), templateFileType E templateFileName, documentDataType (testo, JSON, XML), outputType (html, PDF, Word, Excel) e dati tramite documentDataText O documentDataFile. IL API unisce i dati nel modello e restituisce il documento generato. Utilizzare facoltativo fileMetaData E metaDataJson per metadati aggiuntivi.
Caratteristiche principali
- Tipi di modello: Parola, HTML, O PDF modelli (Base64).
- Dati: documentDataType: testo, JSON, O XML; dati in documentDataText O documentDataFile Base64).
- Produzione: outputType: html, PDF, Word o Excel.
- Asincrono: Utilizzo async per modelli o dati di grandi dimensioni.
:::suggerimento Ideale per Da usare quando hai bisogno di un documento per chiamata (fatture, lettere, report). Per molti documenti da un unico modello usa Genera documenti multipli.
:::
API parametri
| Parametro | Tipo | Necessario | Descrizione |
|---|---|---|---|
| api-key | corda | SÌ | Tuo PDF4me API chiave, Base64 codificato. Prendilo da pannello di controllo. |
| templateFileType | corda | SÌ | html, Word, PDF, HTML, O DOCX. |
| templateFileName | corda | SÌ | Nome del file modello con estensione (ad esempio, invoice_template.html). |
| templateFileData | base64 | SÌ | Contenuto del file modello (Base64). |
| documentDataType | corda | SÌ | testo, JSON, O XML. |
| outputType | corda | SÌ | html, PDF, Word, Excel o HTML. |
| documentDataText | corda | SÌ | JSON/XML dati come testo (se documentDataFile (non fornito). |
| documentDataFile | base64 | NO | File di dati (Base64), alternativa a documentDataText. |
| fileMetaData, metaDataJson | corda | NO | Metadati aggiuntivi. |
| async | booleano | NO | Abilita l'elaborazione asincrona. |
Quando utilizzare Genera documento singolo
- Aspettative e lettereGenera un documento per ogni modello (fattura, contratto, lettera) con dati uniti.
- Rapporti: Produci un singolo report da un modello e JSON/XML dati.
- CertificatiGenera un certificato o un documento per ogni chiamata.
Per schemi di richiesta/risposta ed esempi di codice, vedere Genera documento singolo nel PDF4me API documenti.
Prerequisiti
Prima di utilizzare questo endpoint, assicurati di avere:
- Un valido PDF4me API chiave (Ottieni il tuo API Chiave)
- Un file modello (Word, HTML, O PDF) In Base64 formato
- Dati in JSON O XML formato
Formato di risposta
IL API restituisce il documento generato come dati binari per l'elaborazione sincrona (200 OK) o fornisce un sondaggio URL per l'elaborazione asincrona (202 Accepted).