> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beehivehub.io/llms.txt
> Use this file to discover all available pages before exploring further.

# n8n

<Card color="#c21c68" icon="share-nodes" iconType="solid" href="https://github.com/paybeehive/n8n-nodes-beehivehub" title="n8n">
  Integre a Beehive com o n8n para automatizar fluxos e criar rotinas.
</Card>

**O node da BeehiveHub para n8n permite integrar o gateway de pagamentos da plataforma diretamente aos seus fluxos de automação. Com ele, você pode automatizar cobranças, consultar transações, cadastrar clientes, criar transferências, consultar saldo e gerar links de pagamento sem sair do n8n.**

> Esta página mostra como instalar e usar o node. Para detalhes completos dos campos aceitos em cada operação, consulte também a referência da API.

## Instalação

Você pode instalar o node da BeehiveHub via npm em ambientes self-hosted.

Para a instalação do nó, recomendamos que seu n8n self-hosted seja hospedado em um ambiente [Docker](https://docs.n8n.io/hosting/installation/docker/), seguindo a própria documentação do n8n como base

### Via npm

```bash theme={null}
npm install @paybeehive/n8n-nodes-beehivehub
```

***

## Credenciais

Para usar este node, você precisa de uma **BeehiveHub API Secret Key**.

### Como obter sua chave

1. Faça login no dashboard da paybeehive
2. Vá até as configurações da conta ou seção de API Keys
3. Copie sua `Secret Key`

### Como configurar no n8n

1. No n8n, vá em **Credentials**
2. Clique em **Create Credential**
3. Procure por **BeehiveHub API**
4. Cole sua `Secret Key`
5. Clique em **Save**

> O node usa HTTP Basic Auth internamente. A secret key é enviada como usuário, e a senha é ignorada pela API.

***

## Operações disponíveis

### Transaction

* **Create**: cria uma nova transação (`pix`, `boleto` ou `credit_card`)
* **Get**: consulta uma transação por ID
* **Get Many**: lista transações com filtros
* **Refund**: realiza reembolso total ou parcial
* **Update Delivery Status**: atualiza o status de entrega da transação

### Customer

* **Create**: cadastra um novo cliente
* **Get**: consulta um cliente por ID
* **Get Many**: lista clientes

### Transfer

* **Create**: cria uma transferência
* **Get**: consulta uma transferência por ID

### Balance

* **Get Available**: consulta o saldo disponível

### Payment Link

* **Create**: cria um link de pagamento
* **Get**: consulta um link por ID
* **Get Many**: lista todos os links
* **Update**: atualiza um link existente
* **Delete**: remove um link

***

## Como usar

Depois de instalar o pacote e configurar a credencial:

1. Crie ou abra um workflow no n8n
2. Adicione o node **BeehiveHub**
3. Escolha o recurso desejado, como `Transaction`, `Customer`, `Transfer`, `Balance` ou `Payment Link`
4. Selecione a operação
5. Preencha os campos necessários
6. Execute o node para testar a integração

***

## Valores em centavos

Todos os valores monetários devem ser enviados em centavos.

Exemplos:

* `1000` = R\$ 10,00
* `4990` = R\$ 49,90

***

## Métodos de pagamento aceitos

Ao criar uma transação, o campo `paymentMethod` aceita os seguintes valores:

* `pix`
* `boleto`
* `credit_card`

***

## Compatibilidade

* **n8n**: versão mínima `1.0`
* **Node.js**: `v22` ou superior
* **n8n API version**: `1` em modo strict

> O pacote foi testado em n8n self-hosted. A compatibilidade com n8n Cloud depende da verificação de community nodes.

***

## Uso com IA no n8n

Este node é marcado como `usableAsTool`, o que permite utilizá-lo como ferramenta em fluxos com **n8n AI Agent**.

Isso é útil para cenários em que um agente precisa, por exemplo:

* criar uma cobrança automaticamente
* consultar uma transação
* buscar saldo
* gerar um link de pagamento como parte de um fluxo inteligente

***

## Casos de uso

O node da BeehiveHub é indicado para fluxos como:

* receber dados de formulário e gerar cobrança
* consultar pagamentos automaticamente
* cadastrar clientes sem ação manual
* gerar links de pagamento para enviar em outros canais
* integrar a operação financeira com CRM, planilhas, e-mail ou automações internas

***

## Exemplo de fluxo

Um fluxo simples com n8n pode seguir esta lógica:

1. Receber um formulário ou webhook
2. Criar uma transação Pix
3. Armazenar a resposta em uma planilha ou CRM
4. Enviar o link ou QR Code para o cliente

***

## Observações importantes

* Use sempre sua `Secret Key` correta no ambiente desejado
* Revise os campos obrigatórios conforme o recurso selecionado
* Para payloads mais detalhados, combine esta página com a referência da API
* Em transações com cartão, siga o fluxo seguro de tokenização antes do envio para a API

***

## Recursos úteis

* Documentação da API da paybeehive
* Documentação de Community Nodes do n8n
* Fórum da comunidade n8n
