# n8n-nodes-cisassessment

![Banner image](https://github.com/CIS-Assessment/n8n-nodes-cisassessment/blob/f41ce50d2f7df323e4a3207e7fd8db1e4a7b60cd/.github/logo.png?raw=true)

---

Este é um nó da comunidade n8n. Ele permite que você use o CIS Assessment em seus fluxos de trabalho n8n.

O CIS Assessment é uma ferramenta para avaliações de segurança e conformidade.

[n8n](https://n8n.io/) é uma plataforma de automação de fluxos de trabalho com licença [fair-code](https://docs.n8n.io/reference/license/).

[Instalação](#instalação)  
[Operações](#operações)  
[Credenciais](#credenciais)  
[Compatibilidade](#compatibilidade)  
[Recursos](#recursos)  

## Instalação

Siga o [guia de instalação](https://docs.n8n.io/integrations/community-nodes/installation/) na documentação dos nós da comunidade n8n.

## Operações

- [x] Consulta de créditos da conta **Company**
- [x] Consultar Campanha
- [x] Criar Campanha
- [x] Listar Campanhas
- [x] Listar Usuários (Clientes Company)
- [x] Procurar Usuário (Cliente Company)
- [x] Enviar Passaporte (Link de Questionário)
- [x] Consultar Resultados de Questionário (Inventário)

## Credenciais

Adquira as credenciais de acesso ao CIS Assessment com o administrador da sua conta.
[Documentação - CIS Assessment](https://connect.cisassessment.app)

## Compatibilidade

Para utilizar o nosso Community Node, é necessário atender aos seguintes requisitos:

- [n8n](https://n8n.io/) na versão 1.83.2 ou superior
- Uma conta COMPANY na plataforma do [CIS Assessment](https://company.cisassessment.app)

## Recursos

- [Documentação dos nós da comunidade n8n](https://docs.n8n.io/integrations/community-nodes/)
- [Documentação - CIS Assessment](https://connect.cisassessment.app/n8n)

---

## 🇧🇷 Para Desenvolvedores do Time

### Requisitos do Ambiente

Para trabalhar neste projeto, você precisa ter instalado:

- Git
- Node.js (versão 18 ou superior)
- pnpm (gerenciador de pacotes)
- n8n (instalado globalmente)

### Configuração do Ambiente de Desenvolvimento

1. Clone o repositório:
   `git clone https://github.com/CIS-Assessment/n8n-node-cisassessment.git`

2. Instale as dependências:
   `pnpm install`

3. Para desenvolver localmente:
    1. Compile o projeto `pnpm run build`
    2. Link o pacote localmente `pnpm link`
    3. No projeto onde deseja testar (`~/.n8n/custom`), execute: `pnpm link n8n-nodes-cisassessment`

### Manutenção e Desenvolvimento

- Os arquivos principais dos nós estão em `/nodes`
- As credenciais estão definidas em `/credentials`
- Sempre execute `pnpm lint` antes de commitar mudanças
- Mantenha a documentação atualizada ao adicionar novas funcionalidades

### Fluxo de Trabalho

1. Crie uma branch para sua feature: `feature/nome-da-feature`
2. Faça seus commits seguindo o padrão convencional
3. Execute os testes e o lint
4. Abra um Pull Request para a branch `main`

### Publicação de Novas Versões

1. Atualize a versão no `package.json`
2. Execute `pnpm run build`
3. Faça commit das alterações
4. Publique no npm com `pnpm publish`

#### Para o Github Actions

1. Atualize a versão no `package.json`
2. Execute `pnpm run build`
3. Faça commit das alterações
4. Crie uma tag com a versão atualizada: `git tag v1.0.1`
5. `git push origin v1.0.1`

## License

[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)

## Referências

- [n8n.io](https://n8n.io)
- [Documentação do n8n](https://docs.n8n.io/integrations/creating-nodes/overview/)