Gerar vários documentos
Gerar → Gerar vários documentos
O Gerar vários documentos API Gera vários documentos a partir de um modelo e vários itens de dados. Você envia o modelo (templateFileType, templateFileName, templateFileData Base64), documentDataType (Json ou XML), outputType (Docx, PDFWord, Excel, HTML), documentDataText ou documentDataFile, opcional fileMetaData e metaDataJson, e async. O API retornos JSON com um outputDocuments matriz (ou uma sondagem) URL quando asyncUse o testador abaixo para experimentar; mais detalhes estão nas seções seguintes.
Experimente a opção Gerar Vários Documentos API
:::nota Referência rápida
Ponto final: POST /api/v2/GenerateDocumentMultiple · Obrigatório: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
:::
Use o formulário abaixo para enviar sua API chave, arquivo de modelo (Base64), tipo de dados, tipo de saída e dados (JSON/XML texto ou arquivo). A resposta é JSON Com documentos gerados. Nenhum código é necessário, preencha os campos e clique. Enviar solicitação.
Visão geral, parâmetros e casos de uso
- Overview
- Parameters
- Use cases
O que é Gerar Vários Documentos?
Este endpoint gera vários documentos a partir de um modelo e vários registros de dados (JSON ou XMLVocê fornece o modelo (Word, HTML, ou PDF como Base64), documentDataType (Json ou XML), outputType (Docx, PDFWord, Excel, HTML), e dados via documentDataText ou documentDataFile. O API Produz um documento por registro de dados e os retorna no outputDocuments matriz (ou sondagem) URL quando async).
Principais características
- Um modelo, vários documentosO mesmo modelo foi aplicado a cada registro de dados.
- Tipos de modelo: Docx, Palavra, HTML, ou PDF (Base64).
- Dados: documentDataType: Json ou XML; dados em documentDataText ou documentDataFile.
- Saída: outputType: Docx, PDF, Word, Excel ou HTML.
- Assíncrono: Usar async para grandes lotes.
Use quando precisar de vários documentos a partir de um único modelo (cartas em lote, certificados, etiquetas). Para um único documento por chamada, use Gerar documento único.
API parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| api-key | corda | Sim | Seu PDF4me API chave, Base64 codificado. Obtenha-o do painel. |
| templateFileType | corda | Sim | Docx, Palavra, HTML, ou PDF. |
| templateFileName | corda | Sim | Nome do arquivo modelo com extensão (ex.: sample.docx). |
| templateFileData | base64 | Sim | Conteúdo do arquivo de modelo (Base64). |
| documentDataType | corda | Sim | Json ou XML. |
| outputType | corda | Sim | Docx, PDF, Word, Excel ou HTML. |
| documentDataText | corda | Sim | JSON/XML dados como texto (se documentDataFile não fornecido). |
| documentDataFile | base64 | Não | Arquivo de dados (Base64), alternativa a documentDataText. |
| fileMetaData, metaDataJson | corda | Não | Metadados adicionais. |
| async | booleano | Não | Ativar o processamento assíncrono. |
Quando usar a opção Gerar Vários Documentos
- Cartas e certificados de loteGere vários documentos a partir de um único modelo com dados diferentes (cartas, certificados, etiquetas).
- Relatórios em massaGerar vários relatórios em uma única solicitação.
- Envio de correspondências em massaCombinar um modelo com uma lista de destinatários ou linhas de dados.
Para esquemas de requisição/resposta e exemplos de código, consulte Gerar vários documentos no PDF4me API documentos.
Pré-requisitos
Antes de usar este endpoint, certifique-se de que você possui:
- Um válido PDF4me API chave (Adquira o seu API Chave)
- Um arquivo de modelo (Word, HTML, ou PDF) em Base64 formato
- Dados em JSON ou XML formato
Formato de resposta
O API retornos JSON com outputDocuments matriz contendo os documentos gerados para processamento síncrono (200 OK) ou fornece uma pesquisa URL para processamento assíncrono (202 Accepted).