Pular para o conteúdo principal

​
Collection Postman

Um unico ficheiro com todas as pastas (grupos) da API e seis variaveis na collection: baseUrl, jwt, clientToken, clientSecret, instanceId e instanceToken (este clientToken e o mesmo enviado no body de POST /token e no header X-Client-Token; instanceToken e o valor de X-Instance-Token). Baixar vzaps-public-api.postman_collection.json

​
O que esta documentado

  • Endpoints publicos de instancia: criacao, listagem e cancelamento.
  • Endpoints publicos de billing: assinatura e retomada de assinatura.
  • Endpoints publicos da instancia: sessao, webhook, mensagens, usuarios, grupos, contatos e filas.

​
Como ler os endpoints da instancia

Todos os endpoints da instancia usam o prefixo da API publica: 
/instances/{id}/...

​
Autenticacao

Obtenha um JWT para integracao com POST /token (client_token e client_secret da conta; ver referencia Obter Token nesta secao). A documentacao usa securitySchemes por endpoint para refletir o comportamento real da API:
  • bearerAuth para fluxos autenticados por JWT;
  • instanceTokenHeader + clientTokenHeader para os endpoints da instancia que aceitam tokens.
Em varios desses endpoints, o acesso pode ser feito com JWT do dono da instancia ou com a combinacao X-Instance-Token + X-Client-Token.

​
Observacoes importantes

  • PUT /instances/create e um endpoint publico para integracao, mas ele ainda exige JWT.
  • POST /instances/list usa sempre JWT nesta documentacao.
  • POST /instances/{id}/subscribe segue o fluxo padrao direct na API (metodo de pagamento padrao cadastrado).
  • PUT e DELETE em /instances/{id}/cancel representam o cancelamento da instancia pela API publica.
  • As respostas desses endpoints normalmente usam o envelope code, data e success.