Ir para o conteúdo
WACore api
Entrar
documentação

Contrato da API

HTTP puro sobre JSON. Sem SDK obrigatório, sem dependência de linguagem. Autenticação por chave de app, isolamento por conta e compatibilidade com o dialeto de provedores populares na ponte /v1/bridge.

motor 1.0.0 JSON HMAC-SHA256 OpenAPI 3.1 base /v1

Autenticação

Toda chamada (exceto /v1/health) exige a chave do app. Aceita três formas:

# 1) header apikey (recomendado)
curl https://wacoreapi.zapboot.com/v1/me -H "apikey: SUA_CHAVE"

# 2) Authorization Bearer
curl https://wacoreapi.zapboot.com/v1/me -H "Authorization: Bearer SUA_CHAVE"

# 3) query (só para teste rápido)
curl "https://wacoreapi.zapboot.com/v1/me?apikey=SUA_CHAVE"
A chave é gravada como hash SHA-256: ela aparece uma única vez, no momento da criação. Perdeu? Gere outra e revogue a antiga.

Formato de resposta

Sucesso devolve o recurso; erro devolve código e mensagem legível.

// sucesso
{ "ok": true, "id": "msg_8f21c", "queued": true }

// erro
{ "error": { "code": "BAD_REQUEST",
  "message": "Número inválido." } }
400Dados inválidos
401Chave ausente ou inválida
403Escopo insuficiente
404Instância ou recurso não encontrado
409Conflito de estado (ex.: já conectado)
429Limite da chave ou fila cheia
fluxo completo

Conectar um número e enviar

Quatro chamadas resolvem o caminho inteiro: criar, conectar, acompanhar e enviar.

# 1) cria a instância e recebe o QR
curl -X POST https://wacoreapi.zapboot.com/v1/instances \
  -H "apikey: SUA_CHAVE" -H "content-type: application/json" \
  -d '{"name":"vendas","displayName":"Vendas"}'

# 2) conecta (QR em dataURL; ou use /pair com o telefone)
curl -X POST https://wacoreapi.zapboot.com/v1/instances/vendas/connect \
  -H "apikey: SUA_CHAVE"

# 3) acompanha até "open"
curl https://wacoreapi.zapboot.com/v1/instances/vendas/status \
  -H "apikey: SUA_CHAVE"

# 4) envia (a fila aplica ritmo humano)
curl -X POST https://wacoreapi.zapboot.com/v1/messages/text \
  -H "apikey: SUA_CHAVE" -H "content-type: application/json" \
  -d '{"instance":"vendas","number":"5511999999999","text":"Olá!"}'
webhooks

Receba o que chega no chip

Entrega assinada com HMAC-SHA256, retry exponencial e log de cada tentativa.

Criar

curl -X POST https://wacoreapi.zapboot.com/v1/webhooks \
  -H "apikey: SUA_CHAVE" \
  -H "content-type: application/json" \
  -d '{"url":"https://seu.app/wa-hook"}'

A resposta traz o secret. Guarde: é ele que valida a assinatura.

Validar a assinatura

// Node
const esperado = crypto
  .createHmac('sha256', secret)
  .update(rawBody)
  .digest('hex');

if (esperado !== req.headers['x-wacore-signature'])
  return res.sendStatus(401);
referência

Todos os 36 endpoints principais

A especificação completa e sempre atualizada está em /v1/openapi.json.

MétodoRotaDescrição
GET/v1/healthSaúde do motor (público, sem chave)
GET/v1/openapi.jsonEspecificação OpenAPI 3.1 gerada do próprio router
GET/v1/meIdentidade do app, readiness, instâncias e limites
GET/v1/instancesLista as instâncias do app
POST/v1/instancesCria instância (nome, displayName, proxyId)
GET/v1/instances/:nameDetalha uma instância
PATCH/v1/instances/:nameEdita nome de exibição e proxy
DELETE/v1/instances/:nameRemove a instância e a sessão
POST/v1/instances/:name/connectConecta e devolve disponibilidade de QR
POST/v1/instances/:name/pairPareamento por código de 8 dígitos
POST/v1/instances/:name/disconnectDesconecta (logout opcional)
POST/v1/instances/:name/restartReinicia o socket
GET/v1/instances/:name/qrQR em dataURL mais pairing code
GET/v1/instances/:name/statusEstado, quota, fila e health
POST/v1/instances/:name/check-numbersValida até 200 números (isExist)
POST/v1/instances/:name/presencePresença: digitando, gravando, online
POST/v1/instances/:name/readMarca mensagens como lidas
GET/v1/instances/:name/contactsÚltimos 500 contatos conhecidos
POST/v1/messagesEnfileira mensagem genérica (kind)
POST/v1/messages/textEnfileira texto
POST/v1/messages/mediaEnfileira mídia (URL, base64, path, buffer)
POST/v1/messages/audioÁudio ou mensagem de voz
POST/v1/messages/stickerFigurinha
POST/v1/messages/locationLocalização
POST/v1/messages/contactContato em vCard
POST/v1/messages/pollEnquete
POST/v1/messages/nowEnvio imediato, sem passar pela fila
GET/v1/messagesHistórico com filtros
GET/v1/queueEstatísticas e itens da fila
POST/v1/queue/:id/retryReenfileira um job
POST/v1/queue/:id/cancelCancela um job
POST/v1/instances/:name/pausePausa os envios da instância
POST/v1/instances/:name/resumeRetoma os envios
GET/v1/webhooksLista webhooks do app
POST/v1/webhooksCria webhook e devolve o secret HMAC
DELETE/v1/webhooks/:idRemove webhook
A ponte /v1/bridge expõe o mesmo motor no dialeto de provedores populares (instância no caminho da URL). Migrar é trocar a base e a chave.

Quer testar com a sua chave?

Peça o acesso de avaliação descrevendo o cenário. Liberamos uma instância e a chave para você validar a integração antes de contratar.

Ver integrações