📄 Documentação da API
Bem-vindo à documentação do ProvedorZAP. Nossa API permite enviar mensagens WhatsApp de forma simples e segura, com suporte a múltiplos clientes e integração com os principais ERPs para provedores de internet.
https://provedorzap.com.br
🔐 Autenticação
Todas as requisições (exceto MK-Auth) exigem o header x-api-key com sua API Key.
x-api-key: zap_sua_api_key_aqui
▶️ Iniciar Sessão
Inicializa a sessão WhatsApp do cliente. Após chamar este endpoint, consulte o status para obter o QR Code.
| Header | Valor |
|---|---|
x-api-key | Sua API Key |
Resposta
{ "message": "Comando de inicializacao de sessao enviado." }
📊 Status da Sessão
Retorna o status atual da sessão e o QR Code (quando disponível).
| Status | Descrição |
|---|---|
DISCONNECTED | Sessão não iniciada |
PENDING_QR | Aguardando leitura do QR Code |
CONNECTED | Conectado e pronto para envio |
Resposta (PENDING_QR)
{ "status": "PENDING_QR", "qrCode": "data:image/png;base64,..." }
Resposta (CONNECTED)
{ "status": "CONNECTED", "qrCode": null }
🔄 Resetar Sessão
Encerra a sessão atual, limpa os dados e gera um novo QR Code. Use quando a sessão travar ou o WhatsApp for desconectado.
Resposta
{ "message": "Reset enviado. Aguarde o novo QR Code." }
💬 Enviar Mensagem de Texto
Envia uma mensagem de texto para um número ou grupo. Envio imediato, sem fila.
| Campo | Tipo | Descrição |
|---|---|---|
number | string | Número com DDI (ex: 5511999998888) ou ID de grupo (@g.us) |
message | string | Texto da mensagem |
Resposta (sucesso)
{ "success": true, "messageId": "ID_DA_MENSAGEM" }
Resposta (erro)
{ "success": false, "error": "Descricao do erro" }
⚙️ Envio MK-Auth (com Fila Anti-Banimento)
Endpoint compatível com MK-Auth. Mensagens entram em fila com delays aleatórios para proteger o número de banimentos.
| Campo | Descrição |
|---|---|
number ou to | Número do destinatário |
message ou msg | Texto da mensagem |
login ou account | API Key (alternativa ao header) |
Resposta
{ "success": true, "message": "Mensagem adicionada a fila de envio.", "queuePosition": 1 }
👥 Listar Grupos
Retorna todos os grupos do WhatsApp conectado. Use o id retornado para enviar mensagens a grupos.
Resposta
[
{ "id": "120363XXXXXXXXXX@g.us", "name": "Nome do Grupo" },
{ "id": "120363YYYYYYYYYY@g.us", "name": "Outro Grupo" }
]
🐘 Exemplo em PHP
// Enviar mensagem via PHP $url = 'https://provedorzap.com.br/api/message/send'; $data = [ 'number' => '5511999998888', 'message' => 'Sua fatura vence amanha. Acesse o portal para pagar.' ]; $options = [ 'http' => [ 'method' => 'POST', 'header' => "Content-Type: application/json\r\nx-api-key: zap_sua_api_key\r\n", 'content' => json_encode($data) ] ]; $result = json_decode(file_get_contents($url, false, stream_context_create($options))); if ($result->success) echo "Mensagem enviada!";
🟨 Exemplo em JavaScript
// Enviar mensagem via fetch const response = await fetch('https://provedorzap.com.br/api/message/send', { method: 'POST', headers: { 'Content-Type': 'application/json', 'x-api-key': 'zap_sua_api_key' }, body: JSON.stringify({ number: '5511999998888', message: 'Sua fatura vence amanha!' }) }); const data = await response.json(); console.log(data);
🐍 Exemplo em Python
import requests response = requests.post( 'https://provedorzap.com.br/api/message/send', headers={ 'x-api-key': 'zap_sua_api_key', 'Content-Type': 'application/json' }, json={ 'number': '5511999998888', 'message': 'Sua fatura vence amanha!' } ) print(response.json())
🔧 Configuração MK-Auth
No painel do MK-Auth, configure o envio de WhatsApp com os seguintes dados:
| Campo | Valor |
|---|---|
| URL | https://provedorzap.com.br/send-message |
| Método | POST |
| Campo login/account | Sua API Key |
| Campo número | number ou to |
| Campo mensagem | message ou msg |
/send-message aceita a API Key tanto no header x-api-key quanto nos campos login ou account do body, para compatibilidade total com o MK-Auth.
❓ FAQ
O QR Code não aparece, o que fazer?
Aguarde até 30 segundos após clicar em "Acessar Painel". Se não aparecer, clique em Reconectar para gerar um novo QR Code.
Meu número foi banido, o que fazer?
Use sempre o endpoint /send-message para envios em massa — ele possui fila anti-banimento com delays automáticos. Evite usar o endpoint direto /api/message/send para grandes volumes.
Posso enviar para grupos?
Sim! Use o endpoint /api/groups para obter o ID do grupo (termina em @g.us) e envie normalmente pelo /api/message/send.
Funciona para números do Paraguai?
Sim! Envie o número com DDI 595XXXXXXXX. O sistema trata automaticamente a formatação correta.
O que acontece com mensagens fora do horário comercial?
Mensagens enviadas via /send-message fora do horário das 8h às 18h são salvas automaticamente e reenviadas no próximo dia útil.
Preciso de suporte?
Entre em contato pelo WhatsApp: clique aqui
Área do Cliente →