TurboZap LogoTurboZap
Introdução

Comece aqui

Integre o WhatsApp em minutos com a TurboZap API! 🚀

Nesta documentação você encontrará tudo o que precisa para integrar com a TurboZap API. Desenvolvida em Go com a biblioteca whatsmeow, nossa API oferece alta performance, conexões estáveis e suporte completo para todas as funcionalidades do WhatsApp Web.

O que é a TurboZap API?

A TurboZap API é uma solução completa para integração com WhatsApp, desenvolvida com foco em:

  • Multi-instância: Gerencie múltiplos números em uma única API
  • Conexão via QR Code: Simples como o WhatsApp Web
  • Sessões persistentes: Reconexão automática após reinicialização
  • Webhooks: Receba eventos em tempo real
  • Mensagens interativas: Botões, listas, reações e mais
  • Grupos: Criação e gerenciamento completo

Com a TurboZap, você pode começar a enviar mensagens em minutos, não em semanas.

Primeiros passos

Autenticação

Aprenda a usar sua API Key para autenticação

Criar uma instância

Sua primeira conexão em 5 minutos

Configurar Webhooks

Receba notificações em tempo real

Enviar primeira mensagem

Envie texto, imagens e muito mais

Instalação rápida

Siga este guia passo a passo para configurar e executar a TurboZap API em minutos:

1Requisitos do sistema

Certifique-se de ter instalado:

  • Docker 20.10+ e Docker Compose 2.0+ (recomendado)
  • Ou Go 1.22+ para desenvolvimento local
  • PostgreSQL 16+ (se rodar localmente)
  • Redis 7+ (se rodar localmente)
  • RabbitMQ 3.13+ (se rodar localmente)

2Clonar o repositório

Clonar repositório
$ cd turbozap-api
✔ Repositório clonado com sucesso!

3Configurar variáveis de ambiente

Crie um arquivo .env na raiz do projeto:

.env
# API Configuration
SERVER_PORT=8080
SERVER_HOST=0.0.0.0
API_KEY=sua-api-key-global-segura-aqui

# Database
DATABASE_URL=postgres://postgres:postgres@postgres:5432/turbozap?sslmode=disable

# Redis
REDIS_URL=redis://redis:6379

# RabbitMQ
RABBITMQ_URL=amqp://guest:guest@rabbitmq:5672/

# MinIO (opcional)
MINIO_ENDPOINT=minio:9000
MINIO_ACCESS_KEY=minioadmin
MINIO_SECRET_KEY=minioadmin
MINIO_BUCKET=turbozap-media
MINIO_USE_SSL=false

# Logging
LOG_LEVEL=info
ENVIRONMENT=production

⚠️ Importante: Altere o API_KEY para uma chave segura antes de usar em produção!

4Executar com Docker Compose (Recomendado)

Iniciar serviços
✔ Todos os serviços iniciados!

Isso iniciará todos os serviços necessários:

  • TurboZap API na porta 8080
  • PostgreSQL na porta 5432
  • Redis na porta 6379
  • RabbitMQ Management na porta 15672
  • MinIO Console na porta 9001
  • Grafana na porta 3000
Verificar logs

💡 Dica: Acesse http://localhost:8080/health para verificar se a API está rodando.

5Desenvolvimento Local (Alternativa)

Se preferir rodar localmente sem Docker:

Instalar dependências
✔ Dependências instaladas!
Configurar variáveis
$ export REDIS_URL="redis://localhost:6379"
$ export RABBITMQ_URL="amqp://guest:guest@localhost:5672/"
$ export API_KEY="sua-api-key-global"
Executar API
✔ API rodando em http://localhost:8080

6Criar sua primeira instância

Criar instância
--url http://localhost:8080/instance/create \
--header 'X-API-Key: sua-api-key-global' \
--header 'Content-Type: application/json' \
--data '{"name": "minha-instancia"}'
✔ Instância criada com sucesso!
Resposta
{
  "success": true,
  "data": {
    "instance": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "minha-instancia",
      "api_key": "unique-api-key-for-this-instance",
      "status": "disconnected",
      "created_at": "2024-01-15T10:30:00.000Z"
    }
  }
}

7Conectar via QR Code

Obter QR Code
--url http://localhost:8080/instance/minha-instancia/connect \
--header 'X-API-Key: unique-api-key-for-this-instance'
✔ Escaneie o QR Code no WhatsApp!

A resposta conterá um QR Code em base64. Você pode visualizá-lo ou usar o endpoint GET /instance/:name/qrcode para obter a imagem diretamente.

8Enviar sua primeira mensagem

Enviar mensagem de texto
--url http://localhost:8080/message/minha-instancia/text \
--header 'X-API-Key: unique-api-key-for-this-instance' \
--header 'Content-Type: application/json' \
--data '{
"to": "5511999999999",
"text": "Olá! Essa é minha primeira mensagem via TurboZap! 🚀"
}'
✔ Mensagem enviada com sucesso!
Resposta
{
  "success": true,
  "data": {
    "message_id": "3EB0A1B2C3D4E5F6",
    "status": "sent",
    "timestamp": "2024-01-15T10:35:00.000Z"
  }
}

🎉 Pronto! E agora?

Você já tem a API rodando! Explore os próximos passos:

Recursos principais

Multi-instância

Gerencie múltiplas conexões WhatsApp simultaneamente.

Webhooks em tempo real

Receba notificações instantâneas sobre mensagens e eventos.

Segurança

API Keys seguras e autenticação robusta por instância.

Alta performance

Desenvolvido em Go para máxima performance e baixa latência.

Pronto para começar?

Crie sua primeira instância e comece a enviar mensagens agora.

Ver documentaçãoIr para Dashboard