Integrando APIs Externas (Evolution, Wuzapi, Z-API, Uazapi)
A instalação, manutenção e o funcionamento de todas as APIs e ferramentas de terceiros (sejam de código aberto ou serviços pagos) são de inteira responsabilidade do assinante.
Nosso suporte não presta assistência para a configuração ou falhas de softwares externos. O Z-PRO não oferece nenhuma garantia sobre a estabilidade, segurança ou funcionamento de qualquer ferramenta de terceiro.
Esta documentação fornece o guia técnico para integrar e configurar APIs de conexão não oficiais externas com a sua plataforma Z-PRO.
O foco é mostrar o passo a passo para a integração, caso queira aprender como instalar as APIs, clique nos links:
Tutorial em Vídeo para integração:
Passo a passo:
Pré-requisito: Habilitando as Integrações no Painel Admin
Por padrão, as opções de conexão com APIs externas não são visíveis por padrão. É necessário habilitar no painel do Administrador.
Acesse o painel Admin.
Navegue até o menu Configurações > Integrações.
Preencha as informações (URL e Chave Global/Token) para cada API que deseja disponibilizar.
Somente após esta configuração, a opção de canal correspondente aparecerá no painel dos canais.
1. Integração com Evolution API
A Evolution API é uma solução auto-hospedada (self-hosted) e gratuita, baseada na tecnologia Baileys.
Passo 1: Configuração no Painel Admin
Navegue até Configurações > Integrações > Evolution API.
Preencha os seguintes campos:
URL da API: A URL base da sua instalação da Evolution API.
Global API Key: A chave de autenticação (API_KEY) definida durante a instalação da sua Evolution.
Atenção: Não inclua a barra (/) no final da URL da API. Uma URL incorreta (ex: .../ em vez de ...) causará falha na conexão.
Passo 2: Criando o Canal
Acesse o painel Admin do tenant desejado.
Navegue até Canais > Adicionar Canal. A opção "Evolution API" estará visível.
Dê um nome à conexão e salve. O Z-PRO irá criar a instância e configurar o webhook automaticamente na sua Evolution API.
Observações Importantes:
Conectando uma Instância Existente: Se você já possui uma instância criada na Evolution, basta criar um novo canal no Z-PRO com o mesmo nome exato da instância. O sistema irá sincronizar e configurar o webhook.
Nomenclatura: Não utilize caracteres especiais (como _) no nome da instância, pois isso pode causar falhas na sincronização.
Nome da Instância: Uma vez criado, o nome da instância não pode ser alterado.
2. Integração com Wuzapi (Meow)
Wuzapi (também conhecida como Meow) é outra solução auto-hospedada (self-hosted) e gratuita.
Pré-requisito na Instalação do Wuzapi
No arquivo de configuração (.env) da sua instalação do Wuzapi, é obrigatório preencher a variável API_URL com a URL pública onde sua instância do Wuzapi está acessível.
Passo 1: Configuração no Painel Admin
Navegue até Configurações > Integrações > Wuzapi.
Preencha os seguintes campos:
URL da API: A URL base da sua instalação do Wuzapi.
Chave Global: O token de administrador definido na variável APP_ADMIN_TOKEN do arquivo .env do seu Wuzapi.
Passo 2: Criando o Canal
Acesse o painel Admin e navegue até Canais > Adicionar Canal. A opção "Wuzapi" estará visível.
Dê um nome à conexão e salve. A instância será criada no seu Wuzapi e o webhook será configurado automaticamente. O painel do Z-PRO permitirá gerar tanto o QR Code quanto o Paring Code.
3. Integração com Z-API
A Z-API é uma solução não oficial paga e gerenciada por uma empresa externa. https://www.z-api.io/
Pré-requisito na Plataforma Z-API
Diferente das outras APIs, a instância precisa ser criada primeiro no painel de controle da Z-API. O Z-PRO não pode criar instâncias na Z-API, apenas conectar-se a existentes.
Passo 1: Configuração no Painel Admin
Navegue até Configurações > Integrações > Z-API.
Preencha os seguintes campos:
URL da API: A URL padrão do serviço (https://api.z-api.io).
Chave Global: O seu "Token de Segurança" gerado nas configurações da sua conta na Z-API.
Passo 2: Criando o Canal
Acesse o painel Admin e navegue até Canais > Adicionar Canal. A opção "Z-API" estará visível.
Preencha os campos com as credenciais da instância que você criou na plataforma Z-API:
ID da Instância
Token da Instância
Salve. A partir deste momento, você poderá gerar o QR Code e gerenciar a conexão diretamente pelo painel do Z-PRO.
4. Integração com Uazapi
A Uazapi também é uma solução não oficial paga e gerenciada. https://uazapi.dev/
Passo 1: Configuração no Painel Admin
Navegue até Configurações > Integrações > Uazapi.
Preencha os seguintes campos:
URL da API: A URL do servidor da sua conta Uazapi.
Chave Global: O "Admin Token" fornecido no painel da sua conta Uazapi.
Passo 2: Criando o Canal
A integração com a Uazapi oferece duas possibilidades:
A) Criar uma Nova Instância:
No painel Admin, vá em Canais > Adicionar Canal e selecione "Uazapi".
Dê um nome para a nova instância (ex: "Cliente A").
Deixe os campos ID da Instância e Token em branco.
Salve. O Z-PRO irá criar a nova instância na sua conta Uazapi e preencherá as credenciais automaticamente.
B) Conectar a uma Instância Existente:
Siga os mesmos passos acima, mas desta vez preencha os campos ID da Instância e Token com as informações da instância já existente na sua conta Uazapi.
Atualizado