Pular para o conteúdo principal
Version: 1.0.0

WPP-API

A WPP-API é uma solução completa para integração com o WhatsApp, permitindo que sua aplicação envie e receba mensagens, gerencie múltiplas instâncias e monitore eventos em tempo real através de webhooks. Construída com foco em simplicidade, segurança e escalabilidade.

🚀 O que você pode fazer com a WPP-API​

📱 Gerenciamento de Instâncias​

Crie e gerencie múltiplas conexões WhatsApp simultaneamente:

  • Criar instâncias: Configure novas conexões WhatsApp independentes
  • Autenticação via QR Code: Pareie dispositivos de forma simples e segura
  • Monitoramento de status: Acompanhe o estado de cada conexão em tempo real
  • Reconexão automática: Mantenha suas instâncias sempre ativas
  • Validação de números: Verifique se um número está registrado no WhatsApp antes de enviar mensagens

💬 Envio de Mensagens​

Envie diversos tipos de conteúdo para seus contatos:

  • Mensagens de texto: Texto simples e formatado
  • Imagens: Fotos com legenda opcional
  • Vídeos: Compartilhe vídeos com seus contatos
  • Documentos: Envie PDFs, planilhas e outros arquivos
  • Áudios: Mensagens de voz e arquivos de áudio
  • Stickers: Figurinhas personalizadas
  • Botões interativos: Crie menus e opções para seus usuários
  • Mensagens citadas: Responda a mensagens específicas mantendo o contexto

🪝 Webhooks e Eventos​

Receba notificações em tempo real sobre tudo que acontece:

  • Eventos de conexão: client.connected, client.disconnected, client.paired, client.logged_out
  • QR Code: Receba novos QR Codes para autenticação
  • Mensagens recebidas: Seja notificado instantaneamente de novas mensagens
  • Mensagens enviadas: Confirme o envio e acompanhe o status das suas mensagens
  • Cliques em botões: Saiba quando usuários interagem com botões interativos
  • Assinatura segura: Todos os webhooks são assinados com HMAC-SHA256 para garantir autenticidade

🔒 Segurança​

  • Autenticação via API Key: Todas as requisições são protegidas com chave de acesso única
  • Webhooks assinados: Valide a autenticidade de cada notificação recebida
  • HTTPS obrigatório: Todas as comunicações são criptografadas
  • Ambiente controlado: Acesso restrito para garantir qualidade e conformidade

🔑 Autenticação​

Para se autenticar, utilize a chave de API no cabeçalho x-api-key em todas as requisições:

curl -X GET https://wpp.api.br/instance \
  -H "x-api-key: sua_chave_aqui"

Não possui uma chave de API? Confira nosso guia sobre como obter uma chave de API.

📖 Casos de Uso​

A WPP-API é perfeita para:

  • 🛍️ E-commerce: Notificações de pedidos, atualizações de entrega e suporte ao cliente
  • 🏥 Saúde: Lembretes de consultas, resultados de exames e telemedicina
  • 🏫 Educação: Comunicação com alunos, avisos importantes e materiais de aula
  • 💰 Financeiro: Alertas de transações, boletos e confirmações de pagamento
  • 🎫 Eventos: Confirmações de inscrição, lembretes e informações de acesso
  • 🤖 Chatbots: Automação de atendimento e suporte 24/7
  • 📊 Marketing: Campanhas personalizadas e relacionamento com clientes

🎯 Por onde começar​

  1. Obtenha sua chave de API - Solicite acesso à plataforma
  2. Configure validação de webhooks - Aprenda a validar notificações de forma segura
  3. Crie sua primeira instância - Configure uma conexão WhatsApp
  4. Envie sua primeira mensagem - Comece a se comunicar com seus usuários

📞 Suporte​

Precisa de ajuda? Nossa equipe está à disposição:

📧 E-mail: suporte@wpp.api.br

Authentication​

Security Scheme Type:apiKey
Header parameter name:x-api-key