Tudo que o painel faz,
também está na API.
Instâncias, mensagens, fila durável, grupos, campanhas e webhooks. Autentique com uma API key do workspace ou com a sessão do painel.
API key
Envie x-api-key em todas as chamadas. A chave acessa apenas o workspace dela e respeita os escopos configurados.
curl https://seu-dominio/instances \
-H "x-api-key: $VERTICE_API_KEY"Sessão do painel
Use o cookie vertice_session. Mutações também exigem o header x-csrf-token do cookie vertice_csrf.
GET /auth/me
Cookie: vertice_session=...Respostas
Sucesso em { "data": ... }; erro em { "error": { "code", "message" } }. Webhooks carregam assinatura HMAC no header.
{ "data": { ... } }Explore a API
Endpoints abertos usados pela landing, health check, contratos e arquivos de integração. Não exigem API key.
Explorar público →Cadastro, login, sessão, convites e autenticação em dois fatores. As rotas de escrita por sessão exigem o header CSRF.
Explorar autenticação →Gestão do workspace, equipe, convites, chaves de API, auditoria e métricas agregadas do painel.
Explorar workspace →Cada instância representa um número de WhatsApp. Conecte por QR ou pareamento, configure webhooks e acompanhe o status do socket.
Explorar instâncias →Perfil do número, dispositivo, QR, reinício e comportamentos automáticos da instância.
Explorar configurações →Quem pode ver último acesso, foto, recado e status; confirmações de leitura, chamadas e mensagens temporárias.
Explorar privacidade →Agenda local, metadados, foto, checagem de números, bloqueio e perfil business de contatos.
Explorar contatos →Envio e manipulação de mensagens: texto, mídia, enquetes, localização, contatos, figurinhas, reações, edição, leitura e presença.
Explorar mensagens →Jobs duráveis no Postgres para envios humanizados. A fila respeita delay, idempotência, retry com backoff e o ciclo de entrega do WhatsApp.
Explorar fila →Criação e administração de grupos: participantes, admins, convites, configurações e saída. Requer uma instância conectada.
Explorar grupos →Criação, grupos vinculados, participantes, admins, convites e configurações de comunidades.
Explorar comunidades →Canais (newsletters): criação, metadados, seguir, mutar, mensagens, seguidores e administração.
Explorar canais →Histórico local e ações de chat: arquivar, fixar, mutar, limpar, deletar, etiquetas e notas internas.
Explorar conversas →Histórico e rejeição de chamadas, links de chamada e limites do protocolo para SIP e chamadas originadas.
Explorar ligações →Perfil comercial, catálogo, produtos, coleções, etiquetas e pedidos do WhatsApp Business.
Explorar whatsapp business →Publicação e resposta de status (stories) de texto, imagem e vídeo.
Explorar status →Broadcast para listas de números usando a fila da instância. Cada destinatário vira um job com progresso e cancelamento individual.
Explorar campanhas →Outbox durável com assinatura HMAC-SHA256, filtros por evento e reenvio manual de entregas.
Explorar webhooks →Servidor Model Context Protocol (Streamable HTTP) para agentes de IA operarem o WhatsApp por ferramentas.
Explorar mcp →Planos, limites, Stripe Checkout, portal do cliente e webhook de cobrança.
Explorar faturamento →Operação da plataforma: workspaces, planos, limites, suspensão e visão de receita. Exige conta de plataforma.
Explorar admin →Aliases dos endpoints mais usados da Z-API para facilitar a migração. O token vai na URL e o Client-Token é opcional.
Explorar compatibilidade →Operação de instâncias por parceiros/integradores da plataforma, com tokens de conexão e limites do programa.
Explorar parceiros →Registro mobile, Meta AI e listas de transmissão nativas: recursos que não são expostos pelo protocolo WhatsApp Web.
Explorar mobile →Do zero ao primeiro webhook
Em Configurações → Chaves de API, escolha os escopos read/write e, se quiser, restrinja IPs.
POST /instances, depois POST /instances/:id/connect. Exiba o QR retornado por GET /instances/:id/qr.
Cadastre uma URL HTTPS na instância e valide o HMAC-SHA256 do corpo cru com o webhookSecret.