Gerar documento único
Gerar → Gerar documento único
O Gerar documento único API Gera um documento a partir de um modelo e dados. Você envia o modelo (templateFileType, templateFileName, templateFileData Base64), documentDataType (texto, JSON, XML), outputType (html, PDFWord, Excel), documentDataText ou documentDataFile, opcional fileMetaData e metaDataJson, e async. O API retorna o documento gerado (binário ou por polling) URLUse o testador abaixo para experimentar; mais detalhes estão nas seções seguintes.
Experimente a opção Gerar Documento Único API
:::nota Referência rápida
Ponto final: POST /api/v2/GenerateDocumentSingle · 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 é o documento gerado. 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 Documento Único?
Este endpoint gera um único documento a partir de um modelo (Word, HTML, ou PDF) e dados (JSON ou XMLVocê fornece o arquivo de modelo (Base64), templateFileType e templateFileName, documentDataType (texto, JSON, XML), outputType (html, PDF, Word, Excel), e dados via documentDataText ou documentDataFile. O API Mescla os dados ao modelo e retorna o documento gerado. Use opcionalmente. fileMetaData e metaDataJson para metadados adicionais.
Principais características
- Tipos de modelo: Palavra, HTML, ou PDF modelos (Base64).
- Dados: documentDataType: texto, JSON, ou XML; dados em documentDataText ou documentDataFile (Base64).
- Saída: outputType: html, PDF, Word ou Excel.
- Assíncrono: Usar async Para modelos ou dados extensos.
:::dica Ideal para Use quando precisar de um documento por chamada (faturas, cartas, relatórios). Para vários documentos a partir de um modelo, use Gerar vários documentos. :::
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 | HTML, Word, PDF, HTML, ou DOCX. |
| templateFileName | corda | Sim | Nome do arquivo modelo com extensão (ex.: invoice_template.html). |
| templateFileData | base64 | Sim | Conteúdo do arquivo de modelo (Base64). |
| documentDataType | corda | Sim | texto, JSON, ou XML. |
| outputType | corda | Sim | html, 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 Documento Único
- Faturas e cartasGere um documento por modelo (fatura, contrato, carta) com dados mesclados.
- RelatóriosGere um único relatório a partir de um modelo e JSON/XML dados.
- CertificadosGere um certificado ou documento por chamada.
Para esquemas de requisição/resposta e exemplos de código, consulte Gerar documento único 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 retorna o documento gerado como dados binários para processamento síncrono (200 OK) ou fornece uma pesquisa URL para processamento assíncrono (202 Accepted).