n8n-nodes-nuvem-solution

Este é um node personalizado para n8n que permite integração com as APIs da Nuvem Solution.

Instalação

Instalação via npm

npm install n8n-nodes-nuvem-solution

Instalação manual

1. Clone este repositório:

git clone https://github.com/higorfy/n8n-nodes-nuvem-solution.git
cd n8n-nodes-nuvem-solution

2. Instale as dependências:

npm install

3. Compile o projeto:

npm run build

4. Faça o link do pacote:

npm link

5. No diretório do n8n, faça o link do node:

cd ~/.n8n/custom
npm link n8n-nodes-nuvem-solution

Configuração

Credenciais

Antes de usar o node, você precisa configurar as credenciais da API Nuvem Solution:

1. No n8n, vá para Credentials > Add Credential
2. Procure por "Nuvem Solution API"
3. Preencha os campos:
   • API Key: Sua chave de API da Nuvem Solution
   • Base URL: URL base da API (padrão: https://api.nuvemsolution.com/stg)

Recursos Disponíveis

O node oferece operações para os seguintes recursos:

Usuários (Users)

• Get: Obter um usuário específico
• Get All: Obter todos os usuários
• Create: Criar um novo usuário
• Update: Atualizar um usuário existente
• Delete: Excluir um usuário

Projetos (Projects)

• Get: Obter um projeto específico
• Get All: Obter todos os projetos
• Create: Criar um novo projeto
• Update: Atualizar um projeto existente
• Delete: Excluir um projeto

Tarefas (Tasks)

• Get: Obter uma tarefa específica
• Get All: Obter todas as tarefas
• Create: Criar uma nova tarefa
• Update: Atualizar uma tarefa existente
• Delete: Excluir uma tarefa

Uso

Exemplo: Obter todos os usuários

1. Adicione o node "Nuvem Solution" ao seu workflow
2. Configure:
   • Resource: User
   • Operation: Get All
3. Selecione suas credenciais da Nuvem Solution API
4. Execute o workflow

Exemplo: Criar um novo projeto

1. Adicione o node "Nuvem Solution" ao seu workflow
2. Configure:
   • Resource: Project
   • Operation: Create
   • Additional Fields:
     • Name: Nome do projeto
     • Description: Descrição do projeto
     • Status: Status do projeto (active, inactive, pending)
3. Selecione suas credenciais da Nuvem Solution API
4. Execute o workflow

Desenvolvimento

Pré-requisitos

• Node.js 18.17.0 ou superior
• npm
• n8n instalado localmente

Scripts disponíveis

• npm run build: Compila o TypeScript e processa os ícones
• npm run dev: Compila em modo watch
• npm run lint: Executa o linter
• npm run lintfix: Executa o linter e corrige problemas automaticamente
• npm run format: Formata o código usando Prettier

Estrutura do projeto

n8n-nodes-nuvem-solution/
├── credentials/
│   └── NuvemSolutionApi.credentials.ts
├── nodes/
│   └── NuvemSolution/
│       ├── NuvemSolution.node.ts
│       ├── NuvemSolution.node.json
│       └── nuvemSolution.svg
├── dist/                 # Arquivos compilados
├── package.json
├── tsconfig.json
├── .eslintrc.js
├── .prettierrc.js
├── gulpfile.js
└── README.md

API Reference

Este node é baseado na documentação da API Nuvem Solution disponível em: https://api.nuvemsolution.com/stg/swagger/index.html

Contribuição

1. Faça um fork do projeto
2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
4. Push para a branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

Licença

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

Suporte

Se você encontrar algum problema ou tiver dúvidas:

1. Verifique a documentação da API
2. Abra uma issue no GitHub
3. Entre em contato com o mantenedor do projeto

Changelog

v0.1.0

• Versão inicial
• Suporte para operações básicas de CRUD em Users, Projects e Tasks
• Autenticação via API Key
• Configuração flexível de Base URL