Entrar no painel
Use a ADMIN_API_KEY gerada na instalação da VPS (arquivo .env).
Como integrar uma loja
erg_live_...), Catálogo com Pedido (chave ccp_live_... em /api/v1) ou Personalizado (um nome seu, com o mesmo contrato da IA).API para outros sistemas / IA
Exemplos prontos com a URL deste ambiente. Há duas chaves:
ADMIN_API_KEY painel Hub ·
AUTHENTICATION_API_KEY Evolution (apikey).
| Uso | Base | Auth |
|---|---|---|
| Criar/listar instância, QR, bot, chat, envio pelo Hub | …/hub/api/admin |
x-admin-api-key = ADMIN_API_KEY |
| Envio direto (Evolution) | … |
apikey = AUTHENTICATION_API_KEY |
Nome da instância: só a-z0-9- (ex.: loja-jayne). Criar não desconecta as outras. Mesmo chip não pode em duas instâncias.
POST /instances — cria na Evolution, registra o bot já desativado e devolve QR se ainda não estiver open. Ative quando quiser em POST /instances/{nome}/bot.
GET /instances
GET /instances/{nome}/qr — use se o QR expirou.
POST /instances/{nome}/bot — ativa o bot da instância (aceita campos do body para customizar na hora).
POST /instances/{nome}/bot/disable (ou DELETE) — desativa mantendo a configuração salva.
GET /instances/{nome}/bot — lê a configuração do bot daquela instância.
PUT /instances/{nome}/bot — grava a configuração própria da instância (enabled, gatilhos, delay, palavras). Toda instância nova nasce com enabled: false.
GET /instances/{nome}/chats — lista todas as conversas/chats abertos da instância com nome, telefone, última mensagem e não lidas.
GET /instances/{nome}/chats/{remoteJid}/messages — busca o histórico de mensagens de uma conversa específica.
GET /instances/{nome}/groups — lista todos os grupos da instância no WhatsApp (com nome, ID @g.us e membros).
GET /instances/{nome}/broadcasts — extrai todas as listas de transmissão da instância no WhatsApp com nome, ID @broadcast e os números/telefones de todos os participantes.
POST /messages/send — envio de texto pelo Hub (ADMIN_API_KEY). Aceita telefone (5593...) ou ID de grupo (...@g.us).
POST /messages/send-media — envio de arquivos, PDFs, imagens, vídeos ou áudios pelo Hub (ADMIN_API_KEY). Aceita URL direta ou Base64.
Evolution direta — header apikey = AUTHENTICATION_API_KEY (não é a do painel). Aceita telefone ou ID de grupo em number.
POST /schedules — frequency: once, daily, weekdays, weekly, monthly. Destino pode ser telefone ou grupo.
💬 Chat ao Vivo / Conversas WhatsApp
Instâncias WhatsApp
Criar uma instância nova não derruba a conexão atual. Cada uma usa um celular/chip diferente.
Envio e agendamento
Instâncias cadastradas
Toda instância nova nasce com o bot desativado — ative e configure cada uma individualmente abaixo.
| Nome | Status | Número | Bot |
|---|
Configuração do bot por instância
Cada instância tem o seu próprio bot: status, gatilhos, delay e palavras valem somente para a instância selecionada.
Mensagens agendadas
| Quando | Instância | Destino | Frequência | Status |
|---|
Empresa / plataforma
API pública não precisa de telefone autorizado. API restrita exige cadastrar cada número abaixo.
Telefone autorizado
Use para empresas restritas. Em empresas públicas o cadastro de número é opcional.
Empresas cadastradas
| Nome | Slug | Tipo | URL | Acesso | Chave | Status |
|---|
Telefones autorizados
| Telefone | Empresa | Status |
|---|