Package Information
Documentation
n8n-nodes-scanify
Este é um node da comunidade n8n que permite integrar a API do Scanify diretamente nos seus fluxos de automação.
O Scanify é uma API brasileira de OCR inteligente que extrai, valida e estrutura dados de documentos como boletos, notas fiscais, contratos e outros arquivos em PDF, JPG ou PNG. Tudo pronto para automações, sistemas e IA.
n8n é uma plataforma de automação open source com licença fair-code.
Instalação
Operações
Credenciais
Compatibilidade
Como usar
Recursos
Histórico de versões
Instalação
Siga o guia de instalação oficial para nodes da comunidade.
Para desenvolvimento local, você também pode usar:
npm install
npm run build
npm link
E no seu projeto principal do n8n:
npm link n8n-nodes-scanify
Reinicie o n8n para que o node Scanify apareça na lista.
Operações
Atualmente, este node suporta:
Nodes disponíveis
Node | Tipo | Descrição |
---|---|---|
Scanify |
Ação | Envia documentos (PDF, PNG, JPG) para a API Scanify |
Scanify Trigger |
Trigger | Dispara automaticamente quando a Scanify envia o resultado via callback |
Credenciais
Este pacote utiliza autenticação via API Key.
- Acesse https://scanify.com.br e gere sua chave de API.
- No n8n, vá em Credenciais > Scanify API e adicione sua chave.
- O node
Scanify
utilizará essa credencial automaticamente
Compatibilidade
- Requer n8n v1.18.0 ou superior (usa
NodeConnectionType
) - Testado nas versões:
- n8n
1.18.0
- n8n
1.22.1
- n8n
Sem problemas conhecidos.
Como usar
📤 Envio com Scanify
- Use o node Read Binary File para carregar um arquivo local.
- Conecte ao node Scanify.
- Preencha os campos:
documentType
: Ex:"NFE"
,"BOLETO"
callbackUrl
: Defina como o endpoint gerado peloScanify Trigger
- Execute o fluxo.
Pré-requisitos
O node espera um arquivo binário como entrada. Você pode obtê-lo usando:
Read Binary File
HTTP Request
- Qualquer outro node que forneça binário
Campos obrigatórios:
documentType
: tipo do documento (ex:"BOLETO"
,"NFE"
)callbackUrl
: URL que receberá o resultado do OCR
Campos opcionais:
referenceId
: ID de referência do seu sistemametadata
: objeto JSON com dados adicionais (ex:{ "clienteId": "123" }
)
📥 Recebimento com Scanify Trigger
- Crie um novo workflow.
- Adicione o node Scanify Trigger.
- Ative o workflow.
- O n8n exibirá uma URL como:
https://n8n.seudominio.com/webhook/scanify-document
- Use essa URL no campo
callbackUrl
do nodeScanify
.
Assim que a Scanify concluir o processamento do documento, ela enviará os dados diretamente para esse trigger.
Exemplo de uso
- Adicione o node Read Binary File para carregar um arquivo local
- Conecte ao node Scanify
- Preencha os campos obrigatórios
- Execute o fluxo
- O processamento será feito em background e a resposta será enviada para a
callbackUrl
informada
Recursos
Histórico de versões
Versão | Descrição |
---|---|
1.0.0 | Versão inicial com envio e trigger para recebimento de resultados |