n8n-nodes-superlogica

Este pacote contém nodes personalizados para integração com a API do Superlogica Condomínios no n8n.

Visão Geral

O node Superlogica permite integrar o n8n com a plataforma Superlogica Condomínios, possibilitando a automação de diversas operações relacionadas à gestão condominial, como:

• Gerenciamento de condomínios
• Controle de planos de contas
• Administração de contas bancárias e movimentações
• Gestão de unidades e moradores
• Emissão e controle de boletos
• Registro de recebimentos
• Cadastro de fornecedores

Instalação

Instalação Local

# Navegue até sua pasta de instalação do n8n
cd ~/.n8n

# Instale este pacote
npm install n8n-nodes-superlogica

Instalação Global

npm install -g n8n-nodes-superlogica

Instalação em Docker

Se você estiver usando o n8n com Docker, você pode adicionar este pacote ao seu Dockerfile:

FROM n8nio/n8n

RUN npm install n8n-nodes-superlogica

Configuração

Para utilizar o node Superlogica, você precisa configurar as credenciais de acesso à API:

1. Acesse o sistema Superlogica Condomínios
2. Vá para Todos os usuários (canto superior direito) / API (Integração com outros sistemas) / Aplicativos / Novo App Token
3. Obtenha o app_token e o access_token
4. No n8n, crie uma nova credencial do tipo "Superlogica API" e preencha com os tokens obtidos

Recursos Disponíveis

O node Superlogica oferece acesso aos seguintes recursos da API:

Condomínio

• Listar Condomínios
• Obter Condomínio
• Criar Condomínio
• Atualizar Condomínio

Plano de Contas

• Listar IDs dos Planos de Contas
• Listar Contas de um Plano
• Criar Conta
• Editar Conta
• Excluir Conta

Conta Bancária

• Listar Contas Bancárias
• Obter Saldo
• Criar Conta Bancária
• Atualizar Conta Bancária

Movimentação Bancária

• Listar Movimentações
• Adicionar Movimentação
• Editar Movimentação
• Excluir Movimentação

Unidade

• Listar Unidades
• Obter Unidade
• Criar Unidade
• Atualizar Unidade

Morador

• Listar Moradores
• Obter Morador
• Criar Morador
• Atualizar Morador

Boleto

• Listar Boletos
• Obter Boleto
• Gerar Boleto
• Cancelar Boleto

Recebimento

• Listar Recebimentos
• Registrar Recebimento
• Estornar Recebimento

Fornecedor

• Listar Fornecedores
• Obter Fornecedor
• Criar Fornecedor
• Atualizar Fornecedor

Exemplos de Uso

Exemplo 1: Listar todos os condomínios

1. Adicione o node Superlogica ao seu fluxo
2. Selecione o recurso "Condomínio"
3. Selecione a operação "Listar Condomínios"
4. Execute o node para obter a lista de condomínios

Exemplo 2: Gerar um boleto para um morador

1. Adicione o node Superlogica ao seu fluxo
2. Selecione o recurso "Boleto"
3. Selecione a operação "Gerar Boleto"
4. Preencha os campos obrigatórios:
   • ID do Condomínio
   • ID do Morador
   • Valor
   • Data de Vencimento
   • Descrição
   • ID da Conta Contábil
5. Execute o node para gerar o boleto

Estrutura do Projeto

Este projeto segue uma estrutura modular, onde cada recurso da API está em seu próprio arquivo:

src/
├── resources/
│   ├── condominio.ts
│   ├── planoContas.ts
│   ├── contaBancaria.ts
│   ├── movimentacaoBancaria.ts
│   ├── unidade.ts
│   ├── morador.ts
│   ├── boleto.ts
│   ├── recebimento.ts
│   └── fornecedor.ts
├── utils/
│   └── requestUtils.ts
├── interfaces/
│   └── index.ts
├── resources.ts
└── index.ts
nodes/
└── Superlogica/
    ├── Superlogica.node.ts
    └── superlogica.svg
credentials/
└── SuperlogicaApi.credentials.ts

Desenvolvimento

Pré-requisitos

• Node.js (versão 14 ou superior)
• npm ou yarn

Configuração do Ambiente de Desenvolvimento

# Clone o repositório
git clone https://github.com/seu-usuario/n8n-nodes-superlogica.git

# Entre no diretório
cd n8n-nodes-superlogica

# Instale as dependências
npm install

# Compile o código
npm run build

Testes

# Execute os testes
npm test

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para mais detalhes.

Suporte

Para suporte, entre em contato através de [email protected] ou abra uma issue no GitHub.