Webhooks e API da Airparser

Envie os dados extraídos de documentos para qualquer sistema com webhooks. Notificações em tempo real, integrações instantâneas, controle total para desenvolvedores.

Webhook integration visualization showing real-time data flow

Conecte-se a qualquer sistema

Webhooks permitem receber notificações em tempo real quando documentos são processados. Envie os dados extraídos diretamente para suas aplicações personalizadas, sistemas internos ou qualquer serviço que aceite solicitações HTTP POST.

Perfeito para desenvolvedores que precisam de controle total sobre seus fluxos de processamento de documentos e querem integrar a Airparser a sistemas próprios, bancos de dados personalizados ou arquiteturas de microsserviços.

Por que usar webhooks?

<1s
Entrega em tempo real
100%
Controle para desenvolvedores
Qualquer
Sistema ou plataforma

Como funciona

1. Documento recebido

O documento é enviado para a Airparser por e-mail, upload ou API

2. A IA extrai os dados

A IA da Airparser extrai dados estruturados do documento

3. O webhook é acionado

Um HTTP POST é enviado ao seu endpoint com os dados em JSON

4. Seu sistema processa os dados

Sua aplicação recebe e gerencia os dados

Como criar um webhook na Airparser

Assista a este guia rápido sobre como configurar webhooks na Airparser para começar a receber notificações de dados em tempo real.

Exemplo de payload de webhook

Quando um documento é processado, a Airparser envia um payload JSON para a URL do seu webhook:

JSON
{
  "parser_id": "parser_abc123",
  "document_id": "doc_xyz789",
  "timestamp": "2024-01-15T10:30:00Z",
  "extracted_data": {
    "invoice_number": "INV-2024-001",
    "invoice_date": "2024-01-10",
    "vendor": "Acme Corporation",
    "total_amount": 1250.00,
    "currency": "USD",
    "line_items": [
      {
        "description": "Professional Services",
        "quantity": 10,
        "unit_price": 125.00,
        "total": 1250.00
      }
    ]
  },
  "document_url": "https://airparser.com/documents/doc_xyz789",
  "confidence": 0.98
}

Casos de uso de webhooks

Bancos de dados personalizados

Envie os dados extraídos diretamente para seu sistema PostgreSQL, MySQL, MongoDB ou qualquer banco de dados personalizado.

Sistemas internos

Integre com ERPs próprios, CRMs ou aplicações internas de negócio.

Microsserviços

Acione fluxos de microsserviços e pipelines de processamento distribuído.

Notificações em tempo real

Envie alertas instantâneos para sistemas de notificação personalizados, apps móveis ou painéis.

Análise e relatórios

Alimente dados extraídos em ferramentas de BI e plataformas de análise.

Automação personalizada

Construa fluxos de automação complexos e personalizados de acordo com sua lógica de negócio específica.

Recursos dos webhooks

Entrega segura

Criptografia HTTPS, assinaturas opcionais de webhook para verificação, suporte a lista branca de IP.

Retentativas automáticas

Entregas de webhook com falha são repetidas automaticamente com backoff exponencial.

Logs de entrega

Consulte logs detalhados de todas as entregas de webhook, respostas e tentativas de repetição.

Modo de teste

Teste seu endpoint de webhook com dados de exemplo antes de processar documentos reais.

Cabeçalhos personalizados

Adicione cabeçalhos HTTP personalizados para autenticação, roteamento ou metadados.

Formato JSON

Payloads JSON limpos e estruturados, fáceis de analisar e integrar.

Configurar webhooks

1

Crie seu endpoint de webhook

Configure um endpoint HTTP na sua aplicação que aceite solicitações POST. Pode ser qualquer servidor web, função serverless ou endpoint de API.

2

Configure na Airparser

Nas configurações do seu parser, adicione a URL do webhook. Opcionalmente, configure cabeçalhos personalizados e autenticação.

https://seudominio.com/webhook/airparser
3

Teste sua integração

Use o recurso de teste para enviar um payload de exemplo ao seu endpoint e verificar se tudo funciona corretamente.

4

Gerencie os dados recebidos

Analise o payload JSON na sua aplicação e processe os dados extraídos do documento de acordo com sua lógica de negócio.

5

Retorne uma resposta 200 OK

Seu endpoint deve retornar código de status 200 para confirmar o recebimento. Respostas diferentes de 200 acionam retentativas automáticas.

Exemplo de handler de webhook

Exemplo simples em Node.js/Express para gerenciar webhooks da Airparser:

JAVASCRIPT
const express = require('express');
const app = express();

app.use(express.json());

app.post('/webhook/airparser', (req, res) => {
  const data = req.body;

  console.log('Received data:', data.extracted_data);

  // Process the extracted data
  // e.g., save to database, trigger workflow, etc.

  // Return 200 to acknowledge receipt
  res.status(200).json({ received: true });
});

app.listen(3000, () => {
  console.log('Webhook server running on port 3000');
});

Acesso à API RESTful

Além dos webhooks, a Airparser oferece uma API RESTful completa para acesso programático a todos os recursos.

Enviar documentos

Envie documentos para análise via endpoints de API

Recuperar resultados

Obtenha os dados extraídos com solicitações GET

Gerenciar parsers

Crie e configure parsers programaticamente

Verificar status

Monitore o status e o histórico de processamento

Perguntas frequentes

Quais métodos HTTP são aceitos?

Webhooks usam solicitações HTTP POST com payloads JSON. Seu endpoint deve aceitar solicitações POST e retornar um código de status 2xx.

Como protejo meu endpoint de webhook?

Use HTTPS, verifique assinaturas de webhook, implemente lista branca de IP ou exija chaves API em cabeçalhos personalizados. A Airparser aceita todos esses métodos de autenticação.

O que acontece se meu endpoint estiver fora do ar?

A Airparser tentará entregar novamente automaticamente até 5 vezes com backoff exponencial. Você pode ver todas as tentativas de entrega nos logs de webhook.

Posso ter vários webhooks por parser?

Sim! Configure várias URLs de webhook para enviar os dados extraídos a diferentes sistemas simultaneamente.

Há timeout para entrega de webhooks?

As solicitações de webhook expiram em 30 segundos. Seu endpoint deve responder rápido e processar os dados de forma assíncrona se necessário.

Posso filtrar quais documentos acionam webhooks?

Sim! Configure webhooks condicionais com base nos valores dos dados extraídos, tipos de documento ou critérios personalizados.

O que faço se precisar depurar problemas de webhook?

Consulte os logs detalhados de entrega, que mostram dados de solicitação/resposta, tempos e mensagens de erro. Use o recurso de teste para enviar payloads de exemplo durante o desenvolvimento.

Crie integrações personalizadas com webhooks

Tenha controle total para desenvolvedores com os webhooks e a API da Airparser. Teste gratuito, sem cartão de crédito.

Pronto para expandir seu negócio? É aqui que você começa.