From a8e60b31d181ce5d36eaf2eec969e69abd3858b6 Mon Sep 17 00:00:00 2001 From: OrionDesign Date: Sun, 5 Jan 2025 13:11:36 -0300 Subject: [PATCH] readme --- README.md | 401 +++++++++++++++++++++++++++------------------ README_TEMPLATE.md | 315 ++++++++++++++++++++++++++++------- 2 files changed, 495 insertions(+), 221 deletions(-) diff --git a/README.md b/README.md index d06a9e5..729fa1a 100644 --- a/README.md +++ b/README.md @@ -1,191 +1,268 @@ -Evolution API +![image](https://github.com/user-attachments/assets/813b7b34-377c-42e8-9f1a-12e27e682c7f)


-Este Community Nodes é uma solução 100% gratuita, criada com o intuito de simplificar e auxiliar toda a comunidade a integrar e utilizar ao máximo os principais recursos oferecidos pela Evolution API v2 em seus projetos. Desenvolvido por OrionDesign.

-🚨 Obs: Ainda em desenvolvimento🚨
+Este Community Nodes é uma solução 100% gratuita, criada com o intuito de simplificar e auxiliar toda a comunidade a integrar e utilizar ao máximo os principais recursos oferecidos pela Evolution API v2.2+ em seus projetos no N8N. Desenvolvido por OrionDesign. +

+
+ +
+ Dynamic JSON Badge +
+
+

+

+ ”SetupOrion”      + ”SetupOrion”      + ”SetupOrion”

-

-

📌 Recurso: Instancia

-Este recurso oferece acesso a todas as principais funcionalidades relacionadas às instâncias da Evolution API. Com ele, você pode realizar diversas operações essenciais, como criar uma nova instância, conectar-se a ela, buscar informações, definir comportamentos personalizados, monitorar presença, reiniciar e até mesmo excluir instâncias de maneira simples e eficiente.

-Segue a lista das funções relacionadas:
-
- ✅ Criar Instancia - - O nó "Criar Instância", assim como proprio nome já diz, cria uma nova instância na Evolution API. Você pode configurar o **Nome da Instância**, escolher a **API Key** e o **Número** para geração do "pairingCode", e ainda ajustar diversas opções adicionais, como **Comportamento**, **Proxy**, **Webhook**, **RabbitMQ**, e a integração com **Chatwoot.** Essa flexibilidade permite que à criação da instância seja adaptada a diferentes cenários e necessidades. +

-> Obs: Esta função funciona apenas se estiver usando a `Global API Key` nas credenciais da Evolution API. `ApiKey de instancia` **não** tem poder para criar novas instancias. +

⚙️ Requisitos

+Para utilizar o nosso **Community Node**, é necessário atender aos seguintes requisitos: +- **N8N** na versão **1.54.4** ou superior +- **Evolution API** na versão **2.2.0** ou superior -| Campo | Descrição | Obrigatório | -|----------|----------|----------| -| Nome Da Instância | Nome que será atribuido a instancia | ✅ | -| Apikey Para Instancia | ApiKey (token) que será utilizado para consumir api desta instancia | ❌ | -| Número Do WhatsApp | Numero que será utilizado para se conectar na instancia, usado para gerar o "pairingCode" | ❌ | -| Opções | Configurações e Integrações que podem ser adicionadas a instancia no momento de sua crição | ❌ | +

-Como já descrito, existe o campo de Opções, do qual você pode adicionar novas integrações a sua instancia, veja abaixo mais detalhes sobre cada opção: +

📌 Recursos Disponíveis

+

Instância

+🖥️ Este recurso oferece acesso completo às principais funcionalidades relacionadas às instâncias da Evolution API. Ele permite realizar operações essenciais, como criar novas instâncias, conectar-se a elas, obter informações detalhadas, personalizar comportamentos, monitorar presença, reiniciar e até mesmo excluir instâncias de forma prática e eficiente. +
- 👉🏽 Comportamento - Aqui você pode definir como vai ser o comportamento da instancia: - - | Campo | Descrição | Obrigatório | - |----------|----------|----------| - | Rejeitar Ligações | Rejeitar automaticamente todas as ligações recebidas no Whatsapp | ❌ | - | Mensagem Ao Rejeitar | Mensagem que será enviada automaticamente após rejeitar uma ligação | ❌ | - | Ignorar Grupos | Não receber as mensagens de grupos na API | ❌ | - | Sempre Online | Deixar o Status sempre como Online | ❌ | - | Ler Mensagens | Todas as mensagens serão marcadas como lidas automaticamente, assim que recebidas | ❌ | - | Ler Status | Os Status dos contatos salvos irão chegar na API | ❌ | - | Sincronizar Histórico | Sincronizar todo o histórico de mensagens na API | ❌ | - -
-
- 👉🏽 Proxy - Defina um Proxy para ser usado na instancia: - - | Campo | Descrição | Obrigatório | - |----------|----------|----------| - | Host do Proxy | Endereço ip/url do Proxy | ✅ | - | Porta Do Proxy | Porta do seu Proxy | ✅ | - | Protocolo Do Proxy | Protocolo Http (para IP ou URL sem SSL) ou Https (para URL com SSL) | ✅ | - | Usuário Do Proxy | Usuario do Proxy | ✅ | - | Senha Do Proxy | Senha do Proxy | ✅ | - -
-
- 👉🏽 Webhook - Ative um endereço para consumir o Webhook a partir de eventos da Evolution API - - | Campo | Descrição | Obrigatório | - |----------|----------|----------| - | Url Do Webhook | Url que será enviado os eventos da Evolution API | ✅ | - | Webhook Por Eventos | Cria uma rota para cada evento adicionando o nome do evento no final da URL | ✅ | - | Base64 No Webhook | Envie os dados do base64 das mídias no webhook | ✅ | - | Eventos | Eventos que vai disparar o webhook | ✅ | - -
-
- 👉🏽 RabbitMQ - Sem informações ainda. - -
-
- 👉🏽 Chatwoot - Sem informações ainda. - + Lista de operações +
+    ✅ Criar Instancia +
+
+    ✅ Gerar Qr-Code +
+
+    ✅ Buscar Instancia +
+
+    ✅ Definir Comportamento +
+
+    ✅ Definir Presença +
+
+    ✅ Definir Proxy +
+
+    ✅ Buscar Proxy +
+
+    ✅ Desconectar WhatsApp +
+
+    ✅ Deletar Instancia +
-

- -
-
- ✅ Conectar Instancia - - -
-
- ✅ Buscar Instancia - -
+

Mensagem

+✉️ Este recurso concentra todas as funcionalidades relacionadas ao envio e gerenciamento de mensagens através da Evolution API. Com ele, você pode enviar diversos tipos de conteúdo como textos, imagens, vídeos, áudios, documentos, contatos, listas interativas, botões e até mesmo mensagens PIX. Cada tipo de mensagem possui opções avançadas como delay, mentions, replies e formatações especiais. O recurso foi desenvolvido para proporcionar uma experiência completa de comunicação, permitindo explorar ao máximo os recursos nativos do WhatsApp de forma simples e eficiente. +
- ✅ Definir Comportamento - + Lista de operações +
+    ✅ Enviar Texto +
+
+    ✅ Enviar Imagem +
+
+    ✅ Enviar Video +
+
+    ✅ Enviar Audio +
+
+    ✅ Enviar Documento +
+
+    ✅ Enviar Enquete +
+
+    ✅ Enviar Contato +
+
+    ✅ Enviar Lista +
+
+    ✅ Enviar Botão +
+
+    ✅ Enviar Pix +
+
+    ✅ Enviar Status +
+
+    ✅ Reagir a Mensagem +
+ +

Grupo

+👥 Com este recurso, você conta com um conjunto completo de funcionalidades para gerenciamento de grupos no WhatsApp por meio da Evolution API. Ele abrange desde a criação e administração de grupos até o gerenciamento de participantes, configuração de permissões, links de convite e mensagens temporárias. Tudo foi projetado para oferecer controle eficiente e simplificado na administração de grupos. +
- ✅ Definir Presença - + Lista de operações +
+    ✅ Criar Grupo +
+
+    ✅ Atualizar Imagem do Grupo +
+
+    ✅ Atualizar Nome do Grupo +
+
+    ✅ Atualizar Descrição do Grupo +
+
+    ✅ Atualizar Configurações do Grupo +
+
+    ✅ Atualizar Membros +
+
+    ✅ Buscar Link de convite do Grupo +
+
+    ✅ Revogar Link de convite do Grupo +
+
+    ✅ Enviar Link de Convite do Grupo +
+
+    ✅ Encontrar Participantes +
+
+    ✅ Mensagens Temporarias +
+
+    ✅ Sair do Grupo +
+
+    ✅ Entrar no Grupo +
+ +

Chat

+💬 Este recurso disponibiliza um conjunto abrangente de ferramentas para o gerenciamento de conversas e interações utilizando a Evolution API. Com ele, é possível verificar números, enviar e gerenciar mensagens, manipular arquivos de mídia, controlar status de leitura, administrar contatos e monitorar presença. Todas as operações são desenvolvidas para proporcionar um controle completo e eficiente das comunicações, facilitando a gestão tanto de conversas individuais quanto em grupo. +
- ✅ Reiniciar Instancia - + Lista de operações +
+    ✅ Verificar Numero +
+
+    ✅ Ler Mensagem +
+
+    ✅ Gerenciar Arquivoo +
+
+    ✅ Marcar como Não lido +
+
+    ✅ Deletar Mensagem +
+
+    ✅ Buscar Foto de Perfil +
+
+    ✅ Obter Midia em Base64 +
+
+    ✅ Editar Mensagem +
+
+    ✅ Enviar Presença +
+
+    ✅ Bloquear Contato +
+
+    ✅ Buscar Contatos +
+
+    ✅ Procurar Mensagens +
+
+    ✅ Procurar Status +
+
+    ✅ Procurar Chats +
+ +

Evento

+⚡ Este recurso oferece mecanismos avançados para integração e monitoramento em tempo real das atividades da Evolution API. Ele permite configurar e gerenciar Webhooks e RabbitMQ, possibilitando o acompanhamento de eventos como mensagens recebidas, alterações em grupos, status de conexão e muito mais. Essas funcionalidades foram projetadas para garantir uma comunicação ágil e automatizada entre sua aplicação e a API, promovendo respostas imediatas a diferentes eventos do WhatsApp. +
- ✅ Desconectar Instancia - + Lista de operações +
+    ✅ Webhook +
+
+    ✅ RabbitMQ +
+ +

Integração

+🔗 Este recurso disponibiliza uma ampla gama de conectores para integrar a Evolution API a diversas plataformas e serviços externos. Entre as possibilidades estão conexões com Chatwoot para atendimento ao cliente, Evolution Bot para automações, Typebot para fluxos conversacionais, além de integrações com Flowise e Dify para soluções de inteligência artificial. Essas integrações ampliam as capacidades da API, permitindo criar soluções robustas e automatizadas para diferentes cenários de negócios. +
- ✅ Deletar Instancia - + Lista de operações +
+    ✅ Chatwoot +
+
+    ✅ Evolution Bot +
+
+    ✅ Typebot +
+
+    ✅ Dify +
+
+    ✅ Floise +

-

📌 Recurso: Mensagem

-
- ✅ Enviar Texto - -
-
- ✅ Enviar Imagem - -
-
- ✅ Enviar Video - -
-
- ✅ Enviar Audio - -
-
- ✅ Enviar Documento - -
-
- ✅ Enviar Enquete - -
-
- ✅ Enviar Status - -
+ +

🤝 Contribuição

+ +Contribua para o crescimento deste projeto! Você pode ajudar de diversas formas: +- **Pull Requests**: Envie melhorias, correções ou novas funcionalidades. +- **Issues**: Relate problemas ou sugira novas ideias. +- **Sugestões**: Compartilhe suas opiniões e feedbacks. +- **Documentação**: Ajude a melhorar ou expandir a documentação existente.

-

📌 Recurso: Evento

-
- ✅ Webhook - -
-
- ✅ RabbitMQ - -
+ +

📌 Principais contribuidores

+ + + +

-

📌 Recurso: Integração

-
- ✅ Proxy - -
-
- ✅ Evolution Bot - -
-
- ✅ Chatwoot - -
+ + + + + Star History Chart + + -
- ✅ Typebot - -
-
- ✅ Flowise - -
-
- ✅ Dify - -
-
- ❌ OpenAI - -
-
- ❌ S3 - -
-
-🚨 Obs: Estas opções podem ser adicionadas ou removidas da versão final deste Node.🚨
+

+

+Desenvolvido com ❤️ por OrionDesign +

diff --git a/README_TEMPLATE.md b/README_TEMPLATE.md index 43e5a00..729fa1a 100644 --- a/README_TEMPLATE.md +++ b/README_TEMPLATE.md @@ -1,71 +1,268 @@ -Evolution API +![image](https://github.com/user-attachments/assets/813b7b34-377c-42e8-9f1a-12e27e682c7f)


-Este Community Nodes é uma solução 100% gratuita, criada com o intuito de simplificar e auxiliar toda a comunidade a integrar e utilizar ao máximo os principais recursos oferecidos pela Evolution API v2 em seus projetos. Desenvolvido por OrionDesign.

-🚨 Obs: Ainda em desenvolvimento🚨
+Este Community Nodes é uma solução 100% gratuita, criada com o intuito de simplificar e auxiliar toda a comunidade a integrar e utilizar ao máximo os principais recursos oferecidos pela Evolution API v2.2+ em seus projetos no N8N. Desenvolvido por OrionDesign.

+
+ +
+ Dynamic JSON Badge +
+
+

+

+ ”SetupOrion”      + ”SetupOrion”      + ”SetupOrion” +

+ + +

+ +

⚙️ Requisitos

+ +Para utilizar o nosso **Community Node**, é necessário atender aos seguintes requisitos: +- **N8N** na versão **1.54.4** ou superior +- **Evolution API** na versão **2.2.0** ou superior

-

💡 Features do Node

- -Instancias:
-✅ Criação de Instancia Básica;
-✅ Criação de Instancia com Proxy;
-✅ Busca por Instancia (com e sem filtro);
-✅ Configurações da Instancia;
-✅ Conexão de Instância;
-✅ Reiniciar Instancia;
-✅ Desconectar Instancia;
-✅ Deletar Instancia;
-✅ Set Presence;
+ +

📌 Recursos Disponíveis

+ +

Instância

+🖥️ Este recurso oferece acesso completo às principais funcionalidades relacionadas às instâncias da Evolution API. Ele permite realizar operações essenciais, como criar novas instâncias, conectar-se a elas, obter informações detalhadas, personalizar comportamentos, monitorar presença, reiniciar e até mesmo excluir instâncias de forma prática e eficiente.
-Mensagens:
-✅ Enviar Texto;
-✅ Enviar Imagem;
-✅ Enviar Video;
-✅ Enviar Audio;
-✅ Enviar Documentos;
-✅ Enviar Enquete;
-✅ Enviar Lista;
-✅ Marcação fantasma;
-✅ Enviar Status;
+
+ Lista de operações +
+    ✅ Criar Instancia +
+
+    ✅ Gerar Qr-Code +
+
+    ✅ Buscar Instancia +
+
+    ✅ Definir Comportamento +
+
+    ✅ Definir Presença +
+
+    ✅ Definir Proxy +
+
+    ✅ Buscar Proxy +
+
+    ✅ Desconectar WhatsApp +
+
+    ✅ Deletar Instancia +
+
+ +

Mensagem

+✉️ Este recurso concentra todas as funcionalidades relacionadas ao envio e gerenciamento de mensagens através da Evolution API. Com ele, você pode enviar diversos tipos de conteúdo como textos, imagens, vídeos, áudios, documentos, contatos, listas interativas, botões e até mesmo mensagens PIX. Cada tipo de mensagem possui opções avançadas como delay, mentions, replies e formatações especiais. O recurso foi desenvolvido para proporcionar uma experiência completa de comunicação, permitindo explorar ao máximo os recursos nativos do WhatsApp de forma simples e eficiente.
-Integrações:
-❌ Chatwoot:
-❌ Typebot
-❌ Webhook;
-❌ RabbitMQ;
-❌ OpenAI;
-❌ S3;
+
+ Lista de operações +
+    ✅ Enviar Texto +
+
+    ✅ Enviar Imagem +
+
+    ✅ Enviar Video +
+
+    ✅ Enviar Audio +
+
+    ✅ Enviar Documento +
+
+    ✅ Enviar Enquete +
+
+    ✅ Enviar Contato +
+
+    ✅ Enviar Lista +
+
+    ✅ Enviar Botão +
+
+    ✅ Enviar Pix +
+
+    ✅ Enviar Status +
+
+    ✅ Reagir a Mensagem +
+
+ +

Grupo

+👥 Com este recurso, você conta com um conjunto completo de funcionalidades para gerenciamento de grupos no WhatsApp por meio da Evolution API. Ele abrange desde a criação e administração de grupos até o gerenciamento de participantes, configuração de permissões, links de convite e mensagens temporárias. Tudo foi projetado para oferecer controle eficiente e simplificado na administração de grupos.
-Grupos:
-❌ Criar Grupo;
-❌ Deletar Grupo;
-❌ Atualizar foto do Grupo;
-❌ Alterar descrição do Grupo;
-❌ Altear configurações do Grupo;
-❌ Pegar link de convite do Grupo;
-❌ Adicionar Membro;
-❌ Remover Membro;
-❌ Ver todos os membros do grupo;
-❌ Ver todos os grupos;
-❌ Sair do Grupo;
+
+ Lista de operações +
+    ✅ Criar Grupo +
+
+    ✅ Atualizar Imagem do Grupo +
+
+    ✅ Atualizar Nome do Grupo +
+
+    ✅ Atualizar Descrição do Grupo +
+
+    ✅ Atualizar Configurações do Grupo +
+
+    ✅ Atualizar Membros +
+
+    ✅ Buscar Link de convite do Grupo +
+
+    ✅ Revogar Link de convite do Grupo +
+
+    ✅ Enviar Link de Convite do Grupo +
+
+    ✅ Encontrar Participantes +
+
+    ✅ Mensagens Temporarias +
+
+    ✅ Sair do Grupo +
+
+    ✅ Entrar no Grupo +
+
+

Chat

+💬 Este recurso disponibiliza um conjunto abrangente de ferramentas para o gerenciamento de conversas e interações utilizando a Evolution API. Com ele, é possível verificar números, enviar e gerenciar mensagens, manipular arquivos de mídia, controlar status de leitura, administrar contatos e monitorar presença. Todas as operações são desenvolvidas para proporcionar um controle completo e eficiente das comunicações, facilitando a gestão tanto de conversas individuais quanto em grupo.
-Chats:
-❌ Verificar Numero no Whatsapp;
-❌ Buscar base64/link da mensagem;
-❌ Buscar Contatos;
-❌ Buscar Mensagens;
-❌ Ver todas Tags;
-❌ Aplicar Tag em contato;
+
+ Lista de operações +
+    ✅ Verificar Numero +
+
+    ✅ Ler Mensagem +
+
+    ✅ Gerenciar Arquivoo +
+
+    ✅ Marcar como Não lido +
+
+    ✅ Deletar Mensagem +
+
+    ✅ Buscar Foto de Perfil +
+
+    ✅ Obter Midia em Base64 +
+
+    ✅ Editar Mensagem +
+
+    ✅ Enviar Presença +
+
+    ✅ Bloquear Contato +
+
+    ✅ Buscar Contatos +
+
+    ✅ Procurar Mensagens +
+
+    ✅ Procurar Status +
+
+    ✅ Procurar Chats +
+
+ +

Evento

+⚡ Este recurso oferece mecanismos avançados para integração e monitoramento em tempo real das atividades da Evolution API. Ele permite configurar e gerenciar Webhooks e RabbitMQ, possibilitando o acompanhamento de eventos como mensagens recebidas, alterações em grupos, status de conexão e muito mais. Essas funcionalidades foram projetadas para garantir uma comunicação ágil e automatizada entre sua aplicação e a API, promovendo respostas imediatas a diferentes eventos do WhatsApp.
-Perfil:
-❌ Alterar Nome do Perfil;
-❌ Alterar Status do Perfil;
-❌ Alterar Foto do Perfil;
-❌ Remover Foto do Perfil;
-❌ Ver Configurações de Privacidade;
-❌ Alterar Configurações de Privacidade;
+
+ Lista de operações +
+    ✅ Webhook +
+
+    ✅ RabbitMQ +
+
+ +

Integração

+🔗 Este recurso disponibiliza uma ampla gama de conectores para integrar a Evolution API a diversas plataformas e serviços externos. Entre as possibilidades estão conexões com Chatwoot para atendimento ao cliente, Evolution Bot para automações, Typebot para fluxos conversacionais, além de integrações com Flowise e Dify para soluções de inteligência artificial. Essas integrações ampliam as capacidades da API, permitindo criar soluções robustas e automatizadas para diferentes cenários de negócios.
-🚨 Obs: Estas opções podem ser adicionadas ou removidas da versão final deste Node.🚨
+
+ Lista de operações +
+    ✅ Chatwoot +
+
+    ✅ Evolution Bot +
+
+    ✅ Typebot +
+
+    ✅ Dify +
+
+    ✅ Floise +
+
+ +

+ +

🤝 Contribuição

+ +Contribua para o crescimento deste projeto! Você pode ajudar de diversas formas: +- **Pull Requests**: Envie melhorias, correções ou novas funcionalidades. +- **Issues**: Relate problemas ou sugira novas ideias. +- **Sugestões**: Compartilhe suas opiniões e feedbacks. +- **Documentação**: Ajude a melhorar ou expandir a documentação existente. + +

+ +

📌 Principais contribuidores

+ + + + +

+ + + + + Star History Chart + + + +

+

+Desenvolvido com ❤️ por OrionDesign +