Free

Instalación FZAP Free

La versión gratuita incluye la API Core completa basada en Whatsmeow (Go), con instancias ilimitadas y nodes n8n. Ideal para probar antes de adoptar los módulos de pago.

Requisitos previos

VPS con Docker y Docker Swarm inicializado
Portainer instalado y accesible
PostgreSQL en ejecución (puede ser un servicio en el mismo stack o externo)
Red interna creada (ej: FloudsNet)
Traefik configurado como reverse proxy con Let's Encrypt

Paso a paso

Crea los volúmenes externos

Antes de hacer el deploy, crea los volúmenes necesarios en Portainer o vía terminal:

bash

docker volume create fzap_dbdata
docker volume create fzap_files

Crea el stack en Portainer

En Portainer, ve a Stacks → Add stack. Dale un nombre (ej: fzap) y pega el contenido a continuación en el editor:

Configura las variables

Antes de hacer el deploy, ajusta los siguientes valores en el stack:

ADMIN_TOKEN

Token de autenticación de la API. Cámbialo por un valor seguro.

DB_HOST / DB_USER / DB_PASSWORD / DB_NAME

Credenciales de tu PostgreSQL.

Host(`ejemplo.com`)

Reemplaza con tu dominio real en el label de Traefik.

FZAP_LANGUAGE

Idioma del sistema: pt-BR, en-US, o es-LATAM.

TZ

Zona horaria del contenedor (ej: America/Bogota).

Deploy

Haz clic en Deploy the stack en Portainer. FZAP estará disponible en el dominio configurado en el puerto 8080 (vía Traefik).

Prueba la API

Accede al dashboard desde el navegador e inicia sesión con tu Admin Token (variable ADMIN_TOKEN del stack):

bash

https://seu-dominio.com/dashboard

Explora la documentación interactiva de la API y prueba los endpoints directamente desde el Swagger UI:

bash

https://seu-dominio.com/api

Nodes n8n

Instala los nodes oficiales para integrar FZAP con tus workflows de n8n:

bash

npm install n8n-nodes-fzap

Ver en npm →

Grupo de soporte FZAP Free

Resuelve dudas sobre instalación y configuración con la comunidad

¿Necesitas más?

La versión Free incluye solo la API Core. Para Chatwoot nativo, botones interactivos, tracking de tráfico pago y Meta Ads CAPI, conoce los planes de pago.

Ver planes

Documentación completa de la API →Referencia de Webhooks →

Paso a paso

Crea los volúmenes externos

Antes de hacer el deploy, crea los volúmenes necesarios en Portainer o vía terminal:

bash

docker volume create fzap_dbdata
docker volume create fzap_files

Crea el stack en Portainer

En Portainer, ve a Stacks → Add stack. Dale un nombre (ej: fzap) y pega el contenido a continuación en el 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

      # --- WhatsApp Cloud API (Meta Embedded Signup) ---
      # Configurações para habilitar o fluxo guiado de cadastro direto pela Meta Cloud API.
      # ATENÇÃO: Recurso exclusivo para planos pagos (requer licença válida, não funciona na versão free).
      #- META_APP_ID=                                     # Meta App ID (obtido em developers.facebook.com)
      #- META_APP_SECRET=                                 # Meta App Secret (chave secreta do aplicativo)
      #- META_CONFIG_ID=                                  # Meta Business Login Config ID (ID de configuração do login)

      # --- 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 en GitHub →

Configura las variables

Antes de hacer el deploy, ajusta los siguientes valores en el stack:

ADMIN_TOKEN

Token de autenticación de la API. Cámbialo por un valor seguro.

DB_HOST / DB_USER / DB_PASSWORD / DB_NAME

Credenciales de tu PostgreSQL.

Host(`ejemplo.com`)

Reemplaza con tu dominio real en el label de Traefik.

FZAP_LANGUAGE

Idioma del sistema: pt-BR, en-US, o es-LATAM.

TZ

Zona horaria del contenedor (ej: America/Bogota).

Deploy

Haz clic en Deploy the stack en Portainer. FZAP estará disponible en el dominio configurado en el puerto 8080 (vía Traefik).

Prueba la API

Accede al dashboard desde el navegador e inicia sesión con tu Admin Token (variable ADMIN_TOKEN del stack):

bash

https://seu-dominio.com/dashboard

Explora la documentación interactiva de la API y prueba los endpoints directamente desde el 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 # --- WhatsApp Cloud API (Meta Embedded Signup) --- # Configurações para habilitar o fluxo guiado de cadastro direto pela Meta Cloud API. # ATENÇÃO: Recurso exclusivo para planos pagos (requer licença válida, não funciona na versão free). #- META_APP_ID= # Meta App ID (obtido em developers.facebook.com) #- META_APP_SECRET= # Meta App Secret (chave secreta do aplicativo) #- META_CONFIG_ID= # Meta Business Login Config ID (ID de configuração do login) # --- 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