Extrair dados de formulários de PDF - Analisador de Campos API
PDF4me Extrair dados de formulário de PDF Permite extrair todos os dados e valores dos campos do formulário. PDF documentos que contêm formulários preenchíveis. Isto API processos de serviço PDF arquiva e extrai informações, valores e propriedades dos campos do formulário. PDF formulários. O API recebe PDF conteúdo através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para diversos tipos de campos de formulário e saída de dados estruturados, esta solução é ideal para fluxos de trabalho de processamento de formulários e plataformas de extração de dados.
Autenticando seu API Solicitar
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.
Principais características
- Extração de Campos de FormulárioExtrair todos os tipos de campos de formulário, incluindo campos de texto, caixas de seleção, botões de opção, listas suspensas e campos de assinatura.
- Saída de dados estruturadosRecuperar dados de formulário em formato estruturado JSON formato para fácil integração
- Propriedades do CampoExtrair nomes de campos, valores, tipos e propriedades de validação.
- Base64 CodificaçãoTransmissão segura de conteúdo de arquivos usando Base64 codificação
- Simple API IntegraçãoRESTful API Projetado para fluxos de trabalho automatizados de processamento de formulários.
REST API Ponto final
O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de extração de dados de formulários são realizadas por meio de um único ponto de extremidade:
- Método: POST
- Ponto final:
/api/v2/ExtractPdfFormData
REST API Parâmetros
Lista completa de parâmetros para a função Extrair Dados do Formulário. 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 |
|---|---|---|---|
| docName* | String | Fonte PDF Nome do arquivo com a extensão .pdf adequada para identificação do documento e processamento da extração de dados do formulário. | output.pdf |
| docContent* | Base64 (String) | O conteúdo da entrada PDF arquivo codificado em Base64 Formato para análise de campos de formulário e processamento de extração de dados. | JVBERi... |
Parâmetros opcionais
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| async | Boolean | Ative o processamento assíncrono. Quando true, o API retornos 202 Accepted com um Location cabeçalho para consultar o resultado | true |
Saída
O PDF4me Extrair dados de formulário de PDF REST API Retorna respostas diferentes dependendo do modo de processamento. API Retorna os dados extraídos dos campos do formulário como um JSON resposta.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Processamento síncrono (padrão)
Quando async é false ou não fornecido, o API Retorna imediatamente os dados extraídos do formulário.
Código de status: 200 OK
Formato da resposta:
{
"formFields": [
{
"fieldName": "Name",
"fieldValue": "John Doe",
"fieldType": "text"
},
{
"fieldName": "Email",
"fieldType": "text"
},
{
"fieldName": "Date",
"fieldValue": "2024-01-15",
"fieldType": "date"
}
]
}
A resposta contém uma matriz de campos de formulário com seus nomes, valores e tipos.
Processamento assíncrono
Quando async é true, o API Processa o documento de forma assíncrona.
Resposta inicial:
Código de status: 202 Accepted
Cabeçalhos de resposta:
Location: https://api.pdf4me.com/api/v2/ExtractPdfFormDataStatus/{operationId}
Corpo da resposta:
{
"traceId": "operation-trace-id"
}
Votação para apuração dos resultados:
Use o Location cabeçalho URL Para verificar a conclusão da pesquisa:
const response = await fetch(locationUrl, {
headers: { 'Authorization': 'Basic ' + apiKey }
});
// Continue polling until status code is 200
if (response.status === 200) {
const result = await response.json();
// Process extracted form data
}
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: docContent"} |
| 401 Unauthorized | Inválido ou ausente API chave | {"error": "Unauthorized"} |
| 408 Tempo limite da solicitação | Tempo limite de processamento da solicitação | {"error": "Request timeout"} |
| 500 Internal Server Error | Erro do servidor durante o processamento | {"error": "Internal server error"} |
Entendendo o JSON Resposta
A resposta da extração de dados do formulário é um JSON objeto contendo uma matriz de campos de formulário:
- campos de formulário: Array de objetos de campo de formulário
- nomeDoCampo: O nome do campo do formulário
- valorDoCampoO valor inserido no campo do formulário.
- tipo de campo: O tipo de campo do formulário (texto, caixa de seleção, botão de opção, data, etc.)
Tipos de campos:
Os tipos de campos de formulário mais comuns incluem:
textCampos de entrada de textocheckboxCampos de caixa de seleção (valores booleanos)radio: Grupos de botões de opçãodateCampos de seleção de datanumberCampos de entrada numéricadropdownCampos suspensos/de seleçãosignatureCampos de assinatura digital
Exemplo de solicitação
Cabeçalho
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Observação:
- Adquira o seu API chave do PDF4me Painel
- O API a chave deve ser Base64 codificado e prefixado com "Básico" no Authorization cabeçalho
- Exemplo: Se o seu API chave é
abc123, codifique-o para Base64 e usarAuthorization: Basic YWJjMTIz
Carga útil
Solicitação básica:
{
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"docName": "output.pdf"
}
Com processamento assíncrono:
{
"docContent": "JVBERi0xLjQKJeLjz9MK...",
"docName": "output.pdf",
"async": true
}
Exemplos de código
O PDF4me Extrair dados de formulário de 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Amostra
Java Implementação com tratamento completo de erros e processamento de respostas:
JavaScript Amostra
Node.js e compatível com navegadores JavaScript Implementação:
Google Apps Script Amostra
Google Apps Script implementação para Google Workspace integração:
Funcionalidades de Extração de Dados de Formulários
Capacidades de análise de campo
- Detecção completa de campoIdentifique todos os campos do formulário, incluindo campos ocultos e calculados.
- Extração de valorExtrair os valores atuais e os valores padrão de todos os tipos de campo.
- Análise de propriedadeRecuperar propriedades de campos, incluindo nomes, tipos, posições e regras de validação.
- Validação de dadosVerificar a integridade dos dados de campo e a conformidade com o formato.
Processamento de formulários
- PDF Análise de formulárioAnálise aprofundada de PDF estrutura da forma e relações de campo
- Reconhecimento do tipo de campoIdentificação automática de vários tipos de campos de formulário.
- Processamento em loteProcessar múltiplos formulários e extrair dados de estruturas de formulários complexas.
- Saída EstruturadaGere dados organizados e estruturados para facilitar a integração.
Recursos avançados
- Mapeamento de CampoMapear campos de formulário para colunas de banco de dados ou campos de aplicativo.
- Transformação de dadosConverter dados de formulário para vários formatos de saída (JSON, XML, CSV)
- Regras de ValidaçãoExtrair e aplicar regras e restrições de validação de formulários.
- Resultados profissionaisExtração de alta qualidade adequada para aplicações empresariais.
Casos de uso e aplicações industriais
- Document Management & Processing
- Business & Finance
- Legal & Compliance
- Healthcare & Medical
- Government & Public Sector
- Education & Research
Casos de uso para gerenciamento e processamento de documentos
- Coleta de dados de formuláriosExtrair dados de campos preenchidos PDF formulários para armazenamento de banco de dados
- Digitalização de DocumentosConverter formulários em papel em dados digitais através de PDF processamento
- Migração de dadosExtrair dados de formulários durante a migração de documentos e atualizações do sistema.
- Análise de formulárioAnalisar as taxas de preenchimento de formulários e os padrões de utilização dos campos.
Casos de uso em negócios e finanças
- Processamento de faturasExtrair dados de formulários de faturas e ordens de compra.
- Processamento de CandidaturasProcessar pedidos de empréstimo, sinistros de seguros e formulários de inscrição.
- Dados da pesquisaExtrair respostas de pesquisas de clientes e formulários de feedback.
- Formulários de conformidadeProcessar formulários de conformidade regulamentar e documentos fiscais.
Casos de uso para questões legais e de conformidade
- Formulários LegaisExtrair dados de documentos legais e formulários judiciais.
- Processamento de ContratosProcessar formulários de contrato e dados de acordo
- Conformidade regulatóriaExtrair dados de formulários de conformidade e documentos regulatórios.
- Coleta de EvidênciasExtrair dados de formulários para fins de comprovação e documentação legal.
Casos de uso na área da saúde e medicina
- Formulários do PacienteExtrair dados dos formulários de cadastro de pacientes e histórico médico.
- Reclamações de segurosProcessar formulários de pedidos de reembolso de seguros e documentos de faturamento médico.
- Ensaios clínicosExtrair dados de formulários de pesquisa e documentos de estudos clínicos.
- Registros médicosProcessar formulários médicos e documentos com informações do paciente.
Casos de uso no governo e no setor público
- Serviços ao CidadãoExtrair dados de formulários governamentais e solicitações de cidadãos
- Processamento de ImpostosProcessar formulários fiscais e documentos de declaração financeira.
- Pedidos de LicençaExtrair dados de formulários de pedidos de licenças e autorizações.
- Registros PúblicosProcessar registros públicos e documentos oficiais do governo.
Casos de uso em educação e pesquisa
- Formulários para EstudantesExtrair dados de formulários de matrícula e candidaturas acadêmicas
- Dados de pesquisaProcessar formulários de pesquisa e respostas de questionários
- Formulários de avaliaçãoExtrair dados de formulários de avaliação e análise.
- Formulários AdministrativosProcessar formulários administrativos e documentos institucionais.