n8n-nodes-uzapi

Um nó customizado do n8n para integração com a API Uzapi Business (WhatsApp), permitindo automação completa de mensagens WhatsApp em seus workflows.

📋 Funcionalidades

• Criação de Instâncias WhatsApp: Gere códigos de pareamento para conectar números WhatsApp
• Geração de QR Codes: Converta tokens base64 em QR codes PNG para autenticação
• Envio de Mensagens Multimídia: Suporte completo para:
  • Mensagens de texto (com preview de URLs)
  • Imagens com legendas
  • Áudios
  • Vídeos com legendas
  • Documentos
• Configuração de Webhooks: Receba eventos em tempo real
• Autenticação Flexível: Suporte a Bearer Token

🚀 Instalação

Via npm

npm install n8n-nodes-uzapi-business-autotic

Via Interface do n8n

1. Acesse as configurações do n8n
2. Vá para "Community Nodes"
3. Instale n8n-nodes-uzapi-business-autotic
4. Reinicie o n8n

⚙️ Configuração

1. Credenciais Uzapi

Antes de usar o nó, configure suas credenciais:

1. No n8n, vá para Credentials → Create New
2. Selecione Uzapi API
3. Preencha os campos:
   • Version: Versão da API (padrão: v1)
   • Username: Seu nome de usuário Uzapi
   • Phone Number ID: ID do número (opcional, usado para sendMessage)
   • Bearer Token: Token de autenticação (opcional, usado para sendMessage)

2. Documentação da API

Consulte a documentação oficial da Uzapi para mais detalhes sobre os endpoints.

📖 Como Usar

Operação: Pairing Code

Cria uma nova instância WhatsApp e gera código de pareamento:

{
	"operation": "pairingCode",
	"phoneNumber": "5511999998888",
	"webhook": "https://seu-webhook.com/uzapi-events"
}

Operação: Generate QR Code

Converte dados base64 em QR code PNG:

{
	"operation": "generateQrCode",
	"qrToken": "iVBORw0KGgoAAAANSUhEUgAA..."
}

Operação: Send Message

Envia mensagens de diferentes tipos:

Mensagem de Texto

{
	"operation": "sendMessage",
	"to": "5511999998888",
	"messageType": "text",
	"text": "Olá! Esta é uma mensagem de teste.",
	"previewUrl": true
}

Envio de Imagem

{
	"operation": "sendMessage",
	"to": "5511999998888",
	"messageType": "image",
	"imageLink": "https://exemplo.com/imagem.jpg",
	"imageCaption": "Legenda da imagem"
}

Envio de Documento

{
	"operation": "sendMessage",
	"to": "5511999998888",
	"messageType": "document",
	"documentLink": "https://exemplo.com/documento.pdf"
}

🏗️ Estrutura do Projeto

n8n-nodes-uzapi/
├── credentials/              # Configurações de credenciais
│   ├── UZapiApi.credentials.ts
│   └── uzapiCredentialProperties.ts
├── nodes/UZapi/             # Nó principal
│   ├── Uzapi.node.ts        # Implementação do nó
│   ├── UZapi.node.json      # Metadados do nó
│   ├── apiClient.ts         # Cliente HTTP para API
│   ├── operations/          # Operações disponíveis
│   │   ├── index.ts
│   │   ├── pairingCode.ts
│   │   ├── generateQrCode.ts
│   │   └── sendText.ts
│   └── zapi.svg            # Ícone do nó
├── utils/                   # Utilitários
│   ├── files/
│   ├── interfaces/
│   └── properties/
└── dist/                    # Arquivos compilados

🛠️ Desenvolvimento

Pré-requisitos

• Node.js 16+
• npm ou yarn
• n8n instalado

Configuração Local

1. Clone o repositório:

git clone https://github.com/Autotic/n8n-nodes-uzapi-business.git
cd n8n-nodes-uzapi-business

2. Instale as dependências:

npm install

3. Compile o projeto:

npm run build

4. Link localmente no n8n:

# No diretório do projeto
npm link

# No diretório do n8n
npm link n8n-nodes-uzapi-business

📦 Dependências

Principais

• jimp: Manipulação de imagens
• jsqr: Leitura de QR codes
• pngjs: Processamento de PNG
• qrcode: Geração de QR codes
• sharp: Processamento de imagens

Desenvolvimento

• typescript: Linguagem de desenvolvimento
• eslint: Linting de código
• prettier: Formatação de código
• gulp: Build de assets

🔗 Links Úteis

• Documentação da API UZapi
• Documentação do n8n
• Repositório no GitHub

---