Adicionar campos de formulário ao PDF
Formulários → Adicionar campos de formulário ao PDF
O Adicionar campos de formulário ao PDF API Adiciona campos de formulário (caixas de texto ou caixas de seleção) a um PDF em posições específicas. Você envia o PDF como Base64 (docContent), docName, formFieldType (Caixa de texto ou caixa de seleção), fieldName, initialValue, positionX e positionY, Size, páginas e, opcionalmente async. O API retorna o PDF Com os novos campos de formulário adicionados. Use o testador abaixo para experimentar; mais detalhes estão nas seções a seguir.
Experimente adicionar campos de formulário ao PDF API
:::nota Referência rápida
Ponto final: POST /api/v2/AddFormField · Obrigatório: api-key, docContent, docName, initialValue, positionX, positionY, fieldName, Size, páginas, formFieldType
:::
Use o formulário abaixo para enviar sua API chave, PDF (Base64), tipo de campo (caixa de texto ou caixa de seleção), nome, posição, tamanho e páginas. A resposta é o PDF com os novos campos do formulário. 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 é "Adicionar campos de formulário"? PDF?
Este endpoint adiciona um ou mais campos de formulário a um PDF em posições específicas. Você escolhe. formFieldType (Caixa de texto ou caixa de seleção), defina fieldName, initialValue, positionX e positionY (coordenadas na página), Sizee páginas (por exemplo, 1, 1-3, 1,3,5, 1-). O API retorna o PDF Com os novos campos preenchíveis. Use-os para transformar um documento estático em algo mais. PDF em um formulário ou adicione campos extras a um formulário existente.
Principais características
- Tipos de campo: formFieldType: Caixa de texto ou caixa de seleção.
- Posição e tamanho: positionX, positionY (coordenadas); Size (tamanho do campo).
- Identidade de campo: fieldName (nome único para o campo), initialValue (valor padrão).
- Segmentação de página: páginas: 1, 1-3, 1,3,5, 1- (da página 1 até o final).
- Assíncrono: Usar async para PDFs com muitos campos.
:::dica Ideal para Use quando precisar adicionar caixas de texto preenchíveis ou caixas de seleção a um PDFCombine com Preencher PDF Forma para preencher os campos, ou Extrair dados de formulários de PDF para ler os valores enviados. :::
API parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| api-key | corda | Sim | Seu PDF4me API chave, Base64 codificado. Obtenha-o do painel. |
| docContent | base64 | Sim | PDF conteúdo do arquivo (Base64). |
| docName | corda | Sim | PDF Nome do arquivo com extensão .pdf. |
| initialValue | corda | Sim | Valor inicial/padrão para o campo do formulário. |
| positionX, positionY | inteiro | Sim | Posição X e Y do campo na página. |
| fieldName | corda | Sim | Nome do campo do formulário (identificador único). |
| Size | inteiro | Sim | Tamanho do campo do formulário. |
| páginas | corda | Sim | Páginas: 1, 1-3, 1,3,5, 1,3,7-10, 1-. |
| formFieldType | corda | Sim | Caixa de texto ou Caixa de seleção. |
| async | booleano | Não | Ativar o processamento assíncrono. |
Quando usar Adicionar Campos de Formulário para PDF
- Criação de formulárioAdicione caixas de texto e caixas de seleção a um PDF para que possa ser preenchido.
- ModelosAdicione campos nomeados a um modelo para que possam ser preenchidos através de Preencher PDF Forma ou seu aplicativo.
- Ampliando formuláriosAdicionar campos extras a um campo existente. PDF formulário (ex.: data da assinatura, caixa de seleção de aprovação).
Para esquemas de requisição/resposta e exemplos de código, consulte Adicionar campos de formulário ao PDF 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 em Base64 formato ou um público URL para um PDF arquivo
Formato de resposta
O API retorna um PDF Documento com os campos do formulário adicionados nas posições especificadas.