Nó Vindi

O nó de workflow Vindi é um cliente REST flexível para a API Vindi — plataforma brasileira de assinaturas e cobrança. Diferente de nós de propósito fixo, permite chamar qualquer endpoint Vindi (faturas, clientes, assinaturas, perfis de pagamento) configurando URL, método, headers e body.

ID do nó no editor: vindi_payment
URL padrão: GET https://app.vindi.com.br/api/v1/bills

O que faz

• Envia requisições HTTP autenticadas para a API da Vindi
• Suporta GET, POST, PUT e DELETE
• Retorna status HTTP, data da resposta e headers da resposta
• Auth padrão: Authorization: Basic {{vindi_api_key}}

Use este nó quando precisar de operações Vindi além de uma única ação "criar fatura" — listar faturas, criar clientes, gerenciar assinaturas, etc.

Pré-requisitos

1. Uma conta Vindi
2. API key em Vindi → Configurações → API
3. Chave de integração vindi_api_key em Configurações → Chaves de API

A Vindi usa autenticação Basic. O valor da chave de integração deve ser a string codificada em Base64 api_key: (API key seguida de dois-pontos, depois codificada em Base64), a menos que você armazene o valor completo Basic ... e sobrescreva os headers.

Como configurar

Etapa 1 — Definir credenciais

1. Copie sua API key da Vindi
2. Codifique em Base64 YOUR_API_KEY: (note os dois-pontos no final)
3. Em Configurações → Chaves de API, adicione:
   • Nome: vindi_api_key
   • Valor: credenciais codificadas em Base64

O template de header padrão envia Authorization: Basic {{vindi_api_key}}.

Etapa 2 — Adicionar o nó

Arraste Vindi de Payments para o canvas.

Etapa 3 — Configurar a requisição

Endpoints comuns

Exemplo — criar fatura (POST):

• URL: https://app.vindi.com.br/api/v1/bills
• Method: POST
• Body:

{
  "customer_id": {{variables.vindi_customer_id}},
  "payment_method_code": "pix",
  "bill_items": [
    {
      "product_id": {{variables.vindi_product_id}},
      "amount": {{variables.bill_amount}}
    }
  ]
}

Exemplo — listar faturas pendentes (GET):

• URL: https://app.vindi.com.br/api/v1/bills?query=status:pending
• Method: GET
• Body: deixe vazio

Todos os campos suportam variáveis de workflow.

Etapa 4 — Usar os dados da resposta

O corpo da resposta fica na saída data. Referencie campos aninhados via inspeção da execução ou JavaScript:

Bill ID: {{vindi_1.data.bill.id}}

(O caminho exato depende da estrutura da resposta Vindi.)

Saídas do nó

Dicas e boas práticas

• Crie o cliente antes da fatura — faturas Vindi exigem um customer_id válido
• Use sintaxe de parâmetro de query em URLs GET para filtrar (?query=status:pending)
• Armazene IDs de clientes Vindi nos contatos do WhatsWave como campos personalizados
• Configure webhooks Vindi para bill_paid, charge_rejected, etc.
• Prefira URLs explícitas por etapa do workflow em vez de reutilizar um nó para operações não relacionadas — logs de execução mais claros
• Teste no ambiente sandbox da Vindi quando disponível
• Para fluxos multi-etapa complexos (criar cliente → assinatura → fatura), encadeie vários nós Vindi com nós Variable entre as etapas

Exemplos de casos de uso

Criar assinatura para novo cliente

1. Webhook — cadastro com e-mail e ID do plano
2. Vindi POST /customers — criar cliente
3. Variable — salvar customer.id
4. Vindi POST /subscriptions — vincular plano
5. Enviar WhatsApp mensagem de boas-vindas

Cobrança — lembrar faturas vencidas

1. Schedule diário
2. Vindi GET /bills?query=status:pending
3. Loop sobre as faturas
4. Enviar WhatsApp lembrete com URL da fatura da resposta

Sincronizar status de pagamento com o CRM

1. Webhook — evento Vindi bill_paid
2. Vindi GET /bills/{id} — buscar detalhes
3. Atualização de card CRM — marcar como pago

FAQ

Isso é diferente de um nó HTTP genérico?
Funcionalmente similar, mas pré-configurado com URL base Vindi, template de header de auth e agrupamento na paleta Payments.

Por que 401 Unauthorized?
API key não codificada corretamente em Base64. Codifique your_key: com dois-pontos no final.

Posso usar body YAML?
Não — o body deve ser JSON.

Como faço paginação em listagens?
Adicione parâmetros de query page e per_page nas URLs GET conforme a documentação da API Vindi.

O padrão é GET — por que o POST falhou?
Altere Method para POST e forneça Body (JSON).

Referência da API

Relacionados

• Visão geral de pagamentos
• Nó HTTP / APIs
• Nó Loop