Adicionar campos de formulário a um PDF - API de formulário interativo

PDF4me Adicionar campos de formulário ao PDF Permite adicionar campos de formulário interativos a PDF documentos. Isto API processos de serviço PDF O programa cria arquivos e adiciona campos de formulário (caixas de texto e caixas de seleção) em posições específicas em páginas específicas. API recebe PDF parâmetros de conteúdo e campos de formulário através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para posicionamento flexível, tipos de campos personalizados e direcionamento de página, esta solução é ideal para automação de documentos e interatividade. PDF fluxos de trabalho de desenvolvimento.

Artigos relacionados no blogue

Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.

Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.

Visite o blogue →

Autenticando sua solicitação de API

Para acessar o PDF4me REST APIPara que uma solicitação seja aceita, é necessário incluir as credenciais de autenticação adequadas. A autenticação garante a segurança da comunicação e valida sua identidade como usuário autorizado do sistema. REST API.

Get your api Key

Principais características

• Tipos de campos de formulárioAdicione campos de formulário TextBox e CheckBox ao PDF documentos
• Posicionamento precisoPosicionamento de controle do campo com coordenadas X e Y exatas
• Dimensionamento de campo personalizadoAjuste as dimensões dos campos do formulário para corresponder aos requisitos de design.
• Segmentação flexível de páginasAplicar campos de formulário a páginas específicas ou a documentos inteiros.
• Valores iniciaisDefina valores padrão para os campos do formulário.
• Base64 CodificaçãoTransmissão segura de conteúdo de arquivos usando Base64 codificação
• Simple API IntegraçãoRESTful API projetado para automatizado PDF fluxos de trabalho para criação de formulários

Endpoint da API REST

O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de adição de campos de formulário são realizadas por meio de um único ponto de extremidade:

• Método: POST
• Ponto final: /api/v2/AddFormField

Parâmetros da API REST

Lista completa de parâmetros para Adicionar Campos de Formulário ao PDF REST APIOs parâmetros estão organizados por categoria para melhor compreensão e implementação.

Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios e devem ser fornecidos para o API para funcionar corretamente.

Parâmetros obrigatórios

Parâmetro	Tipo	Descrição	Exemplo
conteúdo do documento*	Base64	O conteúdo da entrada PDF arquivo codificado em Base64	JVBERi...
nomeDoDocumento*	String	Fonte PDF nome do arquivo com extensão .pdf	output.pdf
valor inicial*	String	Valor inicial para o campo do formulário	New input text
posição X*	Integer	Posição X do campo do formulário na página	300
posiçãoY*	Integer	Posição Y do campo do formulário na página	300
nomeDoCampo*	String	Nome do campo do formulário	Input Field Name
Tamanho*	Integer	Tamanho do campo do formulário	4
páginas*	String	Opções de página: "1" para página 1, "1,3,5" para páginas específicas, "2-5" para intervalo de páginas, "1,3,7-10" para páginas mistas, "1-" para páginas de 1 até o final.	1
tipo de campo de formulário*	String	Tipo de campo do formulário: Caixa de texto ou Caixa de seleção	TextBox

Parâmetros opcionais

Parâmetro	Tipo	Descrição	Exemplo
assíncrono	Boolean	Ative o processamento assíncrono. Quando true, o API retorna o status 202 e fornece uma opção de sondagem. URL no cabeçalho de localização	true

Saída

O PDF4me Adicionar campos de formulário ao PDF REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna o PDF como dados binários para processamento síncrono ou fornece uma sondagem URL para processamento assíncrono.

Success Response

Processamento síncrono (padrão)

Quando async não está definido ou está definido como false, o API processa a solicitação imediatamente:

Código de status: 200 OK

Tipo de conteúdo: application/pdf ou application/octet-stream

Corpo da resposta:

O API retorna o PDF arquivo diretamente como dados binários (não JSON).

Como usar:

1. O corpo da resposta contém o binário PDF dados
2. Salve o conteúdo da resposta diretamente como um PDF arquivo
3. Não Base64 A decodificação é necessária para respostas binárias.

Exemplo (JavaScript):

const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly

Asynchronous Processing

Processamento assíncrono

Quando async: true está definido, o API processa a solicitação de forma assíncrona:

Código de status: 202 Accepted

Cabeçalhos de resposta:

Location: https://api.pdf4me.com/api/v2/AddFormField/poll/12345-abcde-67890

Processo de votação:

1. Extraia o Location cabeçalho da resposta 202
2. Faça a pesquisa URL usando GET solicitações
3. Continue votando até receber um 200 OK status
4. A resposta final contém o binário PDF dados

Exemplo de votação:

// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');

// Poll until complete
while (true) {
  const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
  if (pollResponse.status === 200) {
    const pdfBlob = await pollResponse.blob();
    // Process binary PDF
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

Respostas de erro

Código de status	Descrição	Exemplo de resposta
400 Bad Request	Parâmetros de solicitação inválidos ou campos obrigatórios ausentes	{"error": "Missing required parameter: fieldName"}
401 Unauthorized	Inválido ou ausente API chave	{"error": "Unauthorized"}
500 Internal Server Error	Erro do servidor durante o processamento	{"error": "Internal server error"}

Response Format Details

Entendendo a Resposta

• Síncrono (200): Retorna binário PDF dados diretamente
• Assíncrono (202)Retorna o cabeçalho Location para sondagem; a resposta final é binária. PDF
• Não JSON Invólucro: O API retornos PDF como binário, não encapsulado em JSON com Base64 codificação

Exemplo de solicitação

Cabeçalho

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Observação: O API a chave deve ser Base64 codificado. Obtenha o seu API chave do PDF4me Painel

Carga útil

{
  "docContent": "Please put PDF base64 content",
  "docName": "output.pdf",
  "initialValue": "input text",
  "positionX": 300,
  "positionY": 300,
  "fieldName": "Input Field Name",
  "Size": 4,
  "pages": "1",
  "formFieldType": "TextBox"
}

Exemplos de código

O PDF4me Adicionar campos de formulário ao PDF REST API Fornece exemplos de código em várias linguagens de programação. Escolha a linguagem que melhor se adapta ao seu ambiente de desenvolvimento:

C#

C# (CSharp) Exemplo

Completo C# Implementação para adicionar campos de formulário ao PDF:

View C# Sample

Java

Java Amostra

Java Implementação com tratamento completo de erros e processamento de respostas:

View Java Sample

JavaScript

JavaScript Amostra

Node.js e compatível com navegadores JavaScript Implementação:

View JavaScript Sample

Python

Python Amostra

Python implementação com a biblioteca requests e JSON manuseio:

View Python Sample

Salesforce

Salesforce Amostra

Salesforce Apex implementação para CRM integração:

View Salesforce Sample

n8n

n8n Amostra

n8n Implementação de fluxo de trabalho para automação:

View n8n Sample

Google Script

Google Apps Script Amostra

Google Apps Script implementação para Google Workspace integração:

View Google Script Sample

AWS Lambda

AWS Lambda Amostra

Sem servidor AWS Lambda Implementação da função:

View AWS Lambda Sample

Funcionalidades de criação de campos de formulário

Tipos de campos de formulário

• Campos de caixa de textoCriar campos de entrada de texto para que o usuário insira dados e preencha formulários.
• Campos de caixa de seleçãoAdicione elementos de caixa de seleção para opções de seleção e confirmação.
• Tamanhos personalizadosAjuste as dimensões do campo para atender aos requisitos de design e às necessidades de conteúdo.
• Resultados profissionaisCriação de campos de formulário de alta qualidade com funcionalidade precisa.
• Processamento AvançadoSuporte para layouts de formulário complexos e arranjos de campos.

Posicionamento e Layout

• Coordenadas precisasPosicionamento de controle de campo com valores exatos de posição X e Y
• Posicionamento flexívelSuporte para qualquer posição de página e disposição de campos.
• Segmentação de páginaAplicar campos de formulário a páginas específicas ou a documentos inteiros.
• Tamanhos personalizadosDimensões de campo ajustáveis para um design de forma ideal.
• Layout profissionalPosicionamento consistente dos campos de formulário em todas as páginas de destino.

Recursos avançados

• Valores iniciaisDefina valores padrão para os campos a fim de melhorar a experiência do usuário.
• Nomeação de camposNomes de campos personalizados para coleta e processamento de dados de formulários.
• Criação profissionalGeração de campos de formulário de alta qualidade com funcionalidade clara.
• Opções flexíveisParâmetros de campo de formulário personalizáveis para requisitos específicos

Casos de uso e aplicações industriais

Legal & Professional Services

Casos de uso de serviços jurídicos e profissionais

• Formulários de ContratoAdicionar campos de formulário a contratos e acordos para assinaturas digitais.
• Documentação LegalCriar formulários interativos para processamento de documentos legais.
• Formulários de conformidadeCriar formulários para conformidade regulatória e documentação.
• Admissão de ClientesCriar formulários de cadastro de clientes para serviços jurídicos.

Healthcare & Medical

Casos de uso na área da saúde e medicina

• Formulários do PacienteCriar formulários interativos de cadastro de pacientes e histórico médico.
• Documentação médicaCriar formulários para registros e documentação médica.
• Reclamações de seguros: Criar formulários para processamento de pedidos de indenização de seguros
• Formulários de ConsentimentoCriar formulários de consentimento e autorização para procedimentos médicos.

Finance & Banking

Casos de uso em finanças e bancos

• Aplicações financeiras: Criar formulários de solicitação de empréstimo e crédito
• Abertura de contaCriar formulários para abertura de conta e processos de KYC (Conheça Seu Cliente).
• Formulários de transação: Criar formulários para transações e processamento financeiro
• Documentação de ConformidadeCriar formulários para relatórios de conformidade regulatória

Human Resources

Casos de uso de recursos humanos

• Processamento de CandidaturasCriar formulários de candidatura para empregos e inscrições.
• Integração de funcionáriosCriar formulários para integração e documentação de funcionários.
• Criação de questionário: Desenhar pesquisas e questionários interativos em PDF formato
• Avaliações de desempenhoCriar formulários para avaliação de desempenho e feedback.

Business & Enterprise

Casos de uso para empresas e negócios

• Automação de DocumentosCriar formulários interativos para coleta e processamento de dados.
• Coleta de dadosCriar formulários para coletar informações e feedback dos clientes.
• Documentos interativosAdicionar campos de formulário aos existentes PDFs para um maior envolvimento do usuário
• Automação de Processos de NegócioCrie formulários para fluxos de trabalho empresariais automatizados e entrada de dados.

Obtenha ajuda

Get Your API KeyAPI SamplesGetting Started