Free

Instalação FZAP Free

A versão gratuita inclui a API Core completa baseada em Whatsmeow (Go), com instâncias ilimitadas e nodes n8n. Ideal para testar antes de adotar os módulos pagos.

Pré-requisitos

VPS com Docker e Docker Swarm inicializado
Portainer instalado e acessível
PostgreSQL rodando (pode ser um service no mesmo stack ou externo)
Rede interna criada (ex: FloudsNet)
Traefik configurado como reverse proxy com Let's Encrypt

Passo a passo

Crie os volumes externos

Antes de fazer o deploy, crie os volumes necessários no Portainer ou via terminal:

bash

docker volume create fzap_dbdata
docker volume create fzap_files

Crie a stack no Portainer

No Portainer, vá em Stacks → Add stack. Dê um nome (ex: fzap) e cole o conteúdo abaixo no editor:

Configure as variáveis

Antes de fazer o deploy, ajuste os seguintes valores na stack:

ADMIN_TOKEN

Token de autenticação da API. Troque para um valor seguro.

DB_HOST / DB_USER / DB_PASSWORD / DB_NAME

Credenciais do seu PostgreSQL.

Host(`exemplo.com`)

Substitua pelo seu domínio real na label do Traefik.

FZAP_LANGUAGE

Idioma do sistema: pt-BR, en-US, ou es-LATAM.

TZ

Timezone do container (ex: America/Sao_Paulo).

Deploy

Clique em Deploy the stack no Portainer. O FZAP estará disponível no domínio configurado na porta 8080 (via Traefik).

Teste a API

Acesse o dashboard pelo navegador e faça login com seu Admin Token (variável ADMIN_TOKEN da stack):

bash

https://seu-dominio.com/dashboard

Explore a documentação interativa da API e teste os endpoints diretamente pelo Swagger UI:

bash

https://seu-dominio.com/api

Nodes n8n

Instale os nodes oficiais para integrar o FZAP com seus workflows n8n:

bash

npm install n8n-nodes-fzap

Ver no npm →

Grupo de suporte FZAP Free

Tire dúvidas sobre instalação e configuração com a comunidade

Precisa de mais?

A versão Free inclui apenas a API Core. Para Chatwoot nativo, botões interativos, tracking de tráfego pago e Meta Ads CAPI, conheça os planos pagos.

Ver planos

Documentação completa da API →Referência de Webhooks →

Passo a passo

Crie os volumes externos

Antes de fazer o deploy, crie os volumes necessários no Portainer ou via terminal:

bash

docker volume create fzap_dbdata
docker volume create fzap_files

Crie a stack no Portainer

No Portainer, vá em Stacks → Add stack. Dê um nome (ex: fzap) e cole o conteúdo abaixo no editor:

📄 stack.yml

version: "3.7"

services:
  fzap:
    image: dncarbonell/fzap:latest

    networks:
      - FloudsNet

    volumes:
      - fzap_dbdata:/app/dbdata
      - fzap_files:/app/files

    environment:
      # --- Configurações Gerais e Sistema ---
      - TZ=America/Sao_Paulo
      - FZAP_LANGUAGE=pt-BR                               # pt-BR, en-US, es-LATAM
      - PUBLIC_BASE_URL=https://exemplo.com               # URL completa onde a fzap está instalada - Se instalado em subdomínio colocar o subdomínio completo, sempre com "https://". Ex: https://api.exemplo.com
      #- LOG_LEVEL=info                                   # trace, debug, info, warn, error, fatal, panic
      #- CHATWOOT_SYSTEM_IDENTIFIER=flouds.com.br         # Uso interno no Chatwoot - é o identificador do contato de onboarding - Antes era FZAP_SYSTEM_IDENTIFIER
      #- CHATWOOT_SYSTEM_NAME=FZAP                        # Nome exibido no contato de onboarding - Antes era FZAP_SYSTEM_NAME
      #- CHATWOOT_PLATFORM_NAME=Chatwoot                  # Nome da plataforma white label do Chatwoot - Antes era PLATFORM_NAME
      #- CHATWOOT_SERVICE_URL=https://app.chatwoot.com    # Url de exemplo de conexão e integração do Chawtoot - Antes era DEFAULT_SERVICE_URL

      # --- Autenticação e Licença ---
      - ADMIN_TOKEN=admin_token_exemplo                   # Token de autenticação da API. Escolha um valor seguro
      - FLOUDS_LICENCE_KEY=                               # Deixe vazio para usar a versão free - Em caso de assinatura, a key estará no seu dashboard
      - FLOUDS_LIFETIME_LICENCE_KEY=                      # Caso tenha versão vitalícia (licença fixa por domínio - legado)

      # --- Banco de Dados (PostgreSQL) ---
      - DB_DRIVER=postgres
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=fzap
      - DB_USER=postgres
      - DB_PASSWORD=senha_exemplo

      # --- WhatsApp e Webhooks ---
      - SESSION_DEVICE_NAME=Fzap                          # Nome da dispositivo conectado (aparece no celular)
      - WEBHOOK_FORMAT=json
      #- IMAGE_QUALITY_HD=false                           # true para HD, false para padrão

      # --- Mensageria (RabbitMQ) ---
      #- RABBITMQ_ENABLED=true
      #- RABBITMQ_URL=amqp://fzap:fzap@rabbitmq:5672/
      #- RABBITMQ_EXCHANGE=fzap_events
      #- RABBITMQ_PREFIX=fzap
      #- RABBITMQ_FRAME_MAX=131072                        # Tamanho máx de frame (128KB)
      #- RABBITMQ_HEARTBEAT=30                            # Em segundos
      #- RABBITMQ_MAX_RECONNECT=10
      #- RABBITMQ_RECONNECT_DELAY=5                       # Em segundos

      # --- Monitoramento de Erros (Sentry) - Opcional ---
      # O Sentry é uma ferramenta de rastreamento que captura *somente erros* e falhas da aplicação em tempo real.
      # Isso permite que o desenvolvedor identifique e corrija os problemas de forma ativa, sem precisar esperar uma reclamação ou feedback do usuário.
      # A URL (DSN) de integração deve ser obtida com a equipe no grupo de suporte oficial. Deixe vazio caso não queira utilizar.
      #- SENTRY_DSN=
      
    deploy:
      mode: replicated
      replicas: 1
      placement:
        constraints:
          - node.role == manager
      labels:
        # Configuração Traefik
        - traefik.enable=true
        - traefik.http.routers.fzap.rule=Host(`exemplo.com`)
        - traefik.http.routers.fzap.entrypoints=websecure
        - traefik.http.routers.fzap.tls=true
        - traefik.http.routers.fzap.tls.certresolver=letsencryptresolver
        - traefik.http.routers.fzap.service=fzap
        - traefik.http.services.fzap.loadbalancer.server.port=8080

volumes:
  fzap_dbdata:
    name: fzap_dbdata
    external: true
  fzap_files:
    name: fzap_files
    external: true

networks:
  FloudsNet:
    name: FloudsNet
    external: true

Ver stack.yml no GitHub →

Configure as variáveis

Antes de fazer o deploy, ajuste os seguintes valores na stack:

ADMIN_TOKEN

Token de autenticação da API. Troque para um valor seguro.

DB_HOST / DB_USER / DB_PASSWORD / DB_NAME

Credenciais do seu PostgreSQL.

Host(`exemplo.com`)

Substitua pelo seu domínio real na label do Traefik.

FZAP_LANGUAGE

Idioma do sistema: pt-BR, en-US, ou es-LATAM.

TZ

Timezone do container (ex: America/Sao_Paulo).

Deploy

Clique em Deploy the stack no Portainer. O FZAP estará disponível no domínio configurado na porta 8080 (via Traefik).

Teste a API

Acesse o dashboard pelo navegador e faça login com seu Admin Token (variável ADMIN_TOKEN da stack):

bash

https://seu-dominio.com/dashboard

Explore a documentação interativa da API e teste os endpoints diretamente pelo Swagger UI:

bash

https://seu-dominio.com/api

version: "3.7" services: fzap: image: dncarbonell/fzap:latest networks: - FloudsNet volumes: - fzap_dbdata:/app/dbdata - fzap_files:/app/files environment: # --- Configurações Gerais e Sistema --- - TZ=America/Sao_Paulo - FZAP_LANGUAGE=pt-BR # pt-BR, en-US, es-LATAM - PUBLIC_BASE_URL=https://exemplo.com # URL completa onde a fzap está instalada - Se instalado em subdomínio colocar o subdomínio completo, sempre com "https://". Ex: https://api.exemplo.com #- LOG_LEVEL=info # trace, debug, info, warn, error, fatal, panic #- CHATWOOT_SYSTEM_IDENTIFIER=flouds.com.br # Uso interno no Chatwoot - é o identificador do contato de onboarding - Antes era FZAP_SYSTEM_IDENTIFIER #- CHATWOOT_SYSTEM_NAME=FZAP # Nome exibido no contato de onboarding - Antes era FZAP_SYSTEM_NAME #- CHATWOOT_PLATFORM_NAME=Chatwoot # Nome da plataforma white label do Chatwoot - Antes era PLATFORM_NAME #- CHATWOOT_SERVICE_URL=https://app.chatwoot.com # Url de exemplo de conexão e integração do Chawtoot - Antes era DEFAULT_SERVICE_URL # --- Autenticação e Licença --- - ADMIN_TOKEN=admin_token_exemplo # Token de autenticação da API. Escolha um valor seguro - FLOUDS_LICENCE_KEY= # Deixe vazio para usar a versão free - Em caso de assinatura, a key estará no seu dashboard - FLOUDS_LIFETIME_LICENCE_KEY= # Caso tenha versão vitalícia (licença fixa por domínio - legado) # --- Banco de Dados (PostgreSQL) --- - DB_DRIVER=postgres - DB_HOST=postgres - DB_PORT=5432 - DB_NAME=fzap - DB_USER=postgres - DB_PASSWORD=senha_exemplo # --- WhatsApp e Webhooks --- - SESSION_DEVICE_NAME=Fzap # Nome da dispositivo conectado (aparece no celular) - WEBHOOK_FORMAT=json #- IMAGE_QUALITY_HD=false # true para HD, false para padrão # --- Mensageria (RabbitMQ) --- #- RABBITMQ_ENABLED=true #- RABBITMQ_URL=amqp://fzap:fzap@rabbitmq:5672/ #- RABBITMQ_EXCHANGE=fzap_events #- RABBITMQ_PREFIX=fzap #- RABBITMQ_FRAME_MAX=131072 # Tamanho máx de frame (128KB) #- RABBITMQ_HEARTBEAT=30 # Em segundos #- RABBITMQ_MAX_RECONNECT=10 #- RABBITMQ_RECONNECT_DELAY=5 # Em segundos # --- Monitoramento de Erros (Sentry) - Opcional --- # O Sentry é uma ferramenta de rastreamento que captura *somente erros* e falhas da aplicação em tempo real. # Isso permite que o desenvolvedor identifique e corrija os problemas de forma ativa, sem precisar esperar uma reclamação ou feedback do usuário. # A URL (DSN) de integração deve ser obtida com a equipe no grupo de suporte oficial. Deixe vazio caso não queira utilizar. #- SENTRY_DSN= deploy: mode: replicated replicas: 1 placement: constraints: - node.role == manager labels: # Configuração Traefik - traefik.enable=true - traefik.http.routers.fzap.rule=Host(`exemplo.com`) - traefik.http.routers.fzap.entrypoints=websecure - traefik.http.routers.fzap.tls=true - traefik.http.routers.fzap.tls.certresolver=letsencryptresolver - traefik.http.routers.fzap.service=fzap - traefik.http.services.fzap.loadbalancer.server.port=8080 volumes: fzap_dbdata: name: fzap_dbdata external: true fzap_files: name: fzap_files external: true networks: FloudsNet: name: FloudsNet external: true