Preencher PDF Forma
Formulários → Preencher PDF Forma
O Preencher PDF Forma API preenche campos de formulário em um PDF com seus dados. Você envia o modelo. PDF (templateDocContent Base64, templateDocName), dataArray (JSON sequência de nomes e valores de campos) ou InputFormData (matriz de fieldName/fieldValue objetos), outputType (pdf), inputDataType (json) e, opcionalmente, metaData, metaDataJson, async. O API retorna o PDF com os campos do formulário preenchidos. Use o testador abaixo para experimentar; mais detalhes estão nas seções seguintes.
Experimente o enchimento PDF Forma API
:::nota Referência rápida
Ponto final: POST /api/v2/FillPdfForm · Obrigatório: api-key, templateDocName, templateDocContent, dataArray, outputType, inputDataType, InputFormData
:::
Use o formulário abaixo para enviar sua API chave, PDF forma (Base64), e valores de campo (JSON ou InputFormData array). A resposta é o PDF Com os campos preenchidos. 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 é Fill? PDF Forma?
Este endpoint preenche campos de formulário em um PDF com os valores que você fornecer. Você envia o modelo. PDF (Base64 como templateDocContent, templateDocName) e dados de campo, seja como dataArray (JSON string, por exemplo. {"firstname": "John", "lastname": "Adams"}) ou InputFormData (matriz de {fieldName, fieldValue}). Definir outputType para pdf e inputDataType para json. O API retorna o PDF com campos de texto, caixas de seleção e outros elementos de formulário preenchidos. Os nomes dos campos devem corresponder aos nomes no PDF.
Principais características
- Modelo PDF: templateDocContent (Base64), templateDocName (ex.: formulário.pdf).
- Dados de campo: dataArray (JSON string) ou InputFormData (matriz de fieldName/fieldValue).
- Saída: outputType (pdf), inputDataType (json).
- Opcional: metaData, metaDataJson para metadados adicionais.
- Assíncrono: Usar async Para formulários grandes ou enchimento em lote.
:::dica Melhor para Use quando você tiver um PDF formulário e deseja preenchê-lo programaticamente (aplicativos, contratos, pesquisas). Combine com Adicionar campos de formulário ao PDF para criar o formulário, ou Extrair dados de formulários de PDF para ler os valores preenchidos. :::
API parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| api-key | corda | Sim | Seu PDF4me API chave, Base64 codificado. Obtenha-o do painel. |
| templateDocName | corda | Sim | Modelo PDF Nome do arquivo com extensão .pdf. |
| templateDocContent | base64 | Sim | Modelo PDF conteúdo do arquivo (Base64). |
| dataArray | corda | Sim | JSON string com nomes e valores de campos (por exemplo, {"firstname": "John", "lastname": "Adams"}). |
| outputType | corda | Sim | Tipo de saída (ex.: pdf). |
| inputDataType | corda | Sim | Tipo de dados de entrada (ex.: json). |
| InputFormData | variedade | Sim | Conjunto de {fieldName, fieldValue} objetos. |
| metaData, metaDataJson | corda | Não | Metadados adicionais (opcional). |
| async | booleano | Não | Ativar o processamento assíncrono. |
Quando usar o Preenchimento PDF Forma
- Aplicações e pesquisas: Popular PDF Formulários do seu banco de dados ou dados inseridos pelo usuário (aplicações, cadastros, pesquisas).
- Contratos e cartasPreencha o modelo PDFs Com nomes, datas e termos.
- Processamento em lotePreencher várias cópias do mesmo formulário com dados diferentes (por exemplo, certificados, etiquetas).
- Fluxos de trabalhoGerar preenchido PDFs de CRM, ERPou outros sistemas.
Para esquemas de requisição/resposta e exemplos de código, consulte Preencha um PDF Forma 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)
- A PDF documento com campos de formulário em Base64 formato
- Nomes de campos de formulário que correspondem aos campos do seu PDF
Formato de resposta
O API retorna um PDF Documento com os campos do formulário preenchidos com os valores fornecidos.