Documentação Completa

Documentação ZippyZap

Tudo que você precisa saber para integrar WhatsApp em suas aplicações de forma profissional, segura e escalável.

Sobre o ZippyZap

O ZippyZap é uma plataforma completa de API WhatsApp Business que permite integrar funcionalidades de mensageria WhatsApp em suas aplicações, sistemas e processos de negócio de forma simples, rápida e confiável.

Rápido
Integração em minutos com nossa API RESTful intuitiva
Seguro
Autenticação robusta, rate limiting e proteção contra abusos
Escalável
Infraestrutura preparada para milhares de mensagens por minuto

Principais Recursos

Envio de mensagens de texto, imagens, documentos e mídias
Webhooks em tempo real para receber mensagens e status
Autenticação segura via API Keys
Rate limiting inteligente por plano
Suporte a múltiplas sessões WhatsApp
Dashboard completo para gerenciamento
Logs detalhados de todas as operações
Documentação completa e exemplos de código

Casos de Uso

E-commerce
Automatize notificações de pedidos, atualizações de entrega e suporte ao cliente
  • Confirmação de pedidos em tempo real
  • Rastreamento de entregas
  • Recuperação de carrinho abandonado
  • Promoções e ofertas personalizadas
Notificações
Envie alertas, lembretes e notificações importantes para seus usuários
  • Lembretes de agendamentos
  • Alertas de segurança (2FA)
  • Atualizações de sistema
  • Confirmações de transações
Marketing
Campanhas de marketing direto com alto engajamento
  • Campanhas promocionais segmentadas
  • Newsletters e atualizações
  • Pesquisas de satisfação
  • Programas de fidelidade
Atendimento
Suporte ao cliente automatizado e eficiente
  • Chatbots inteligentes
  • Respostas automáticas
  • Tickets de suporte
  • FAQ automatizado

Como Utilizar

1
Crie sua Conta
Registre-se gratuitamente e receba 1000 mensagens para testar

Acesse a plataforma e crie sua conta em menos de 2 minutos. Você receberá acesso imediato ao dashboard e poderá começar a testar a API.

2
Gere sua API Key
Crie uma chave de API para autenticar suas requisições

No dashboard, acesse a seção "API Keys" e gere uma nova chave. Guarde-a em local seguro, pois ela será necessária para todas as chamadas à API.

Exemplo de API Key:
zapi_live_abc123def456ghi789
3
Configure o WhatsApp
Conecte sua conta WhatsApp escaneando o QR Code

Acesse a seção "WhatsApp" no dashboard e escaneie o QR Code com seu WhatsApp. Sua sessão ficará ativa e pronta para enviar mensagens.

Mantenha seu WhatsApp conectado à internet para receber mensagens
4
Envie sua Primeira Mensagem
Faça sua primeira chamada à API e envie uma mensagem
curl -X POST https://api.zippyzap.com/whatsapp \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "11999999999",
"type": "text",
"message": "Olá! Sua mensagem foi enviada."
}'

Webhooks

Como Funcionam os Webhooks
Receba notificações em tempo real sobre eventos do WhatsApp

Webhooks são chamadas HTTP POST que o ZippyZap faz para sua aplicação quando eventos importantes acontecem, como recebimento de mensagens, confirmações de entrega, leitura, etc.

Configuração do Webhook

  1. 1Acesse o dashboard e vá para "Configurações → Webhooks"
  2. 2Insira a URL do seu endpoint (ex: https://seusite.com/webhook)
  3. 3Selecione os eventos que deseja receber
  4. 4Salve e teste a conexão
Eventos Disponíveis
  • message.received
  • message.sent
  • message.delivered
  • message.read
  • message.failed
  • session.connected
  • session.disconnected
Segurança
  • Todas as requisições incluem header X-Webhook-Signature
  • Valide a assinatura usando seu webhook secret
  • Use HTTPS para receber webhooks
  • Responda com status 200 em até 5 segundos
Exemplo de Payload
Estrutura de dados recebida no webhook
{
"event": "message.received",
"timestamp": "2024-11-22T10:30:00Z",
"data": {
"messageId": "msg_abc123",
"from": "+5511999999999",
"to": "+5511888888888",
"type": "text",
"message": "Olá!",
"timestamp": "2024-11-22T10:30:00Z"
}
}
Implementação do Handler
Exemplo de como processar webhooks em Node.js
// Node.js/Express exemplo
app.post('/webhook', (req, res) => {
const { event, data } = req.body;
switch(event) {
case 'message.received':
console.log('Nova mensagem:', data.message);
// Processar mensagem recebida
break;
case 'message.sent':
console.log('Mensagem enviada:', data.messageId);
break;
case 'message.delivered':
console.log('Mensagem entregue:', data.messageId);
break;
case 'message.read':
console.log('Mensagem lida:', data.messageId);
break;
}
res.status(200).send('OK');
});

Segurança e Prevenção de Abusos

Mecanismos de Segurança
Como protegemos sua conta e prevenimos uso indevido

Autenticação por API Key

Todas as requisições devem incluir uma API Key válida no headerX-API-Key

Rate Limiting

Limites de requisições por minuto baseados no seu plano para evitar sobrecarga

Criptografia TLS

Todas as comunicações são criptografadas usando TLS 1.3

Logs de Auditoria

Todas as ações são registradas para análise e detecção de anomalias

Detecção de Spam

Sistema automático identifica e bloqueia padrões de spam

Validação de Conteúdo

Verificação automática de conteúdo suspeito ou malicioso

Políticas de Uso Aceitável
Práticas proibidas que podem resultar em suspensão da conta
Envio de spam ou mensagens não solicitadas em massa
Compartilhamento de conteúdo ilegal, ofensivo ou malicioso
Uso da API para phishing, fraudes ou golpes
Tentativas de burlar limites de rate limiting
Compartilhamento de API Keys com terceiros não autorizados
Uso de múltiplas contas para contornar limites
Envio de mensagens para números sem consentimento prévio
Violação das políticas do WhatsApp Business
Boas Práticas
Recomendações para uso seguro e eficiente da API

Obtenha Consentimento

Sempre obtenha permissão antes de enviar mensagens para um número

Respeite Horários

Evite enviar mensagens em horários inadequados (noite/madrugada)

Ofereça Opt-out

Permita que usuários cancelem o recebimento de mensagens facilmente

Mantenha API Keys Seguras

Nunca exponha suas chaves em código público ou frontend

Monitore Uso

Acompanhe métricas e logs para detectar anomalias rapidamente

Use Webhooks

Implemente webhooks para rastrear status e evitar reenvios desnecessários

Valide Números

Verifique formato e validade dos números antes de enviar

Implemente Retry Logic

Use backoff exponencial para retentar mensagens falhadas

API Reference

Status da Sessão
Possíveis estados da conexão com o WhatsApp
StatusSignificado
initializingSessão sendo criada
qrcodeQR válido para escanear
scanningCliente escaneando
connectedSessão autenticada
timeoutQR expirou
errorSessão falhou
POST/whatsapp
Enviar Mensagem
Envia uma mensagem de texto via WhatsApp

Headers

X-API-KeystringrequiredSua chave de API
Content-Typestringrequiredapplication/json

Body Parameters

tostringrequiredNúmero de destino no formato DDD + número (ex: 11999999999)
typestringrequiredTipo da mensagem: text, image, document, audio, video
messagestringrequiredConteúdo da mensagem

Response

{
"message": "Mensagem enviada para a fila"
}
GET/whatsapp/qrcode
Obter QR Code
Retorna o QR Code para autenticação do WhatsApp

Headers

X-API-KeystringrequiredSua chave de API

Response

{
"status": "qr_received",
"qr": "data:image/png;base64,...."
}
POST/whatsapp/session
Criar Sessão WhatsApp
Inicia uma nova sessão de autenticação WhatsApp

Headers

X-API-KeystringrequiredSua chave de API

Response

{
"message": "Sessão criada com sucesso"
}
GET/whatsapp/status
Verificar Status da Sessão
Retorna o status atual da conexão WhatsApp

Headers

X-API-KeystringrequiredSua chave de API

Response

{
"status": "connected"
}

Perguntas Frequentes (FAQ)

Como obtenho minha API Key?

Após criar sua conta, acesse o dashboard e vá para a seção "API Keys". Clique em "Criar Nova Chave", dê um nome descritivo e a chave será gerada instantaneamente.

Preciso de um número WhatsApp Business oficial?

Não! O ZippyZap funciona com WhatsApp regular (não Business). Você pode usar seu número WhatsApp pessoal ou criar um novo número.

Qual é o limite de mensagens por segundo?

Os limites variam por plano: Free (10 req/min), Pro (100 req/min), Enterprise (customizado).

Limites e Planos

Free
Plano Gratuito
Perfeito para testes e projetos pequenos
1.000/mês
  • 1.000 mensagens/mês
  • 10 req/minuto
  • 1 sessão WhatsApp
  • Webhooks básicos
  • Suporte por email
Pro
Plano Pro
Para empresas em crescimento
50.000/mês
  • 50.000 mensagens/mês
  • 100 req/minuto
  • 5 sessões WhatsApp
  • Webhooks avançados
  • Suporte prioritário
  • Analytics detalhado
Enterprise
Plano Enterprise
Soluções customizadas
Ilimitado
  • Mensagens ilimitadas
  • Rate limit customizado
  • Sessões ilimitadas
  • Webhooks customizados
  • Suporte 24/7
  • SLA garantido
  • Infraestrutura dedicada

Pronto para Começar?

Crie sua conta gratuitamente e comece a enviar mensagens WhatsApp em minutos