Pular para o conteúdo principal

​
O que voce encontra aqui

Esta documentacao reune os endpoints publicos da VZaps para criacao de instancias, billing, sessao, webhook, mensagens, usuarios, grupos, contatos, filas e integracoes (TypeBot, Chatwoot).

Comece por aqui

Veja a base URL, os headers de autenticacao e o fluxo minimo para criar e conectar uma instancia.

​
Areas principais

Autenticacao

Entenda quando usar Authorization, X-Client-Token e X-Instance-Token.

Fluxo inicial

Siga o passo a passo recomendado para criar, assinar, conectar e operar sua instancia.

Referencia da API

Navegue por todos os endpoints publicos da API com request e response de exemplo.

​
Integracoes

TypeBot

Fluxos conversacionais automaticos no WhatsApp: gatilhos, prioridade e sessoes.

Chatwoot

Atendimento omnichannel: WhatsApp da instancia ligado ao inbox Chatwoot (ida e volta).

​
Escopo desta documentacao

  • Instancias e billing: criar instancia, listar, iniciar assinatura, retomar assinatura e cancelar.
  • Demais grupos da API: sessao, webhook, mensagens, usuarios, grupos, contatos, filas, TypeBot e Chatwoot.
  • Autenticacao: regras reais de uso dos headers da API publica.
A base URL de producao desta documentacao e https://api.vzaps.com, por exemplo https://api.vzaps.com/instances/{id}/session/qr.

​
Antes de integrar

  • Tenha um JWT valido para os endpoints de instancia e billing.
  • Guarde com seguranca o X-Client-Token e o token da instancia retornado na criacao.
  • Para os demais endpoints da instancia, use JWT ou a combinacao X-Instance-Token + X-Client-Token, conforme o seu fluxo.