perfex-api

n8n community node for Perfex CRM

Package Information

Downloads: 0 weekly / 17 monthly
Latest Version: 0.1.52
Author: Your Name

Documentation

n8n-nodes-perfex-api

Este é um nó da comunidade para o n8n que permite integração com o Perfex CRM API.

Instalação

Existem algumas maneiras de instalar este nó:

  1. Instalação via npm (recomendado):

    npm install n8n-nodes-perfex-api
    
  2. Instalação Local (Desenvolvimento/Teste):

    • Clone este repositório
    • Navegue até o diretório raiz do n8n
    • Execute: npm install /caminho/completo/para/n8n-nodes-perfex
    • Reinicie sua instância n8n

Configuração das Credenciais

  1. Abra seu n8n
  2. Vá para Configurações > Credenciais
  3. Clique em "Criar Nova Credencial"
  4. Selecione "Perfex API"
  5. Preencha os seguintes campos:
    • Base URL: URL base da sua instalação do Perfex (ex: https://seu-dominio.com)
    • API Token: Token de API gerado no Perfex (Setup > Settings > API)

Recursos Suportados

Leads

  • Listar todos os leads
  • Obter lead por ID
  • Criar novo lead
  • Atualizar lead existente
  • Deletar lead

Clientes

  • Listar todos os clientes
  • Obter cliente por ID
  • Criar novo cliente
  • Atualizar cliente existente
  • Deletar cliente

Contatos

  • Listar todos os contatos
  • Obter contato por ID
  • Criar novo contato
  • Atualizar contato existente
  • Deletar contato

Exemplos de Uso

Exemplo 1: Criar um novo cliente

  1. Adicione o nó "Perfex"
  2. Selecione a operação "Criar Cliente"
  3. Configure os campos necessários:
    • company: Nome da empresa
    • vat: Número do VAT
    • phonenumber: Telefone
    • country: País
    • city: Cidade
    • zip: CEP
    • state: Estado
    • address: Endereço

Exemplo 2: Atualizar um contato

  1. Adicione o nó "Perfex"
  2. Selecione a operação "Atualizar Contato"
  3. Forneça o ID do contato
  4. Configure os campos que deseja atualizar

Pré-requisitos

  • n8n versão 1.0.0 ou superior
  • Perfex CRM com API habilitada
  • Credenciais de API válidas do Perfex CRM

Desenvolvimento

Este nó foi criado usando o template n8n-nodes-starter e TypeScript.

  • Para instalar dependências: npm install
  • Para compilar: npm run build
  • Para desenvolvimento contínuo: npm run dev

Suporte

Para relatar problemas ou solicitar novas funcionalidades, por favor abra uma issue no GitHub:
https://github.com/Matheusbaiense/Node-Community-Perfex/issues

Licença

MIT

Discussion