GET
/
wa
/
instances
/
{instance_id}
/
qrcode
curl --request GET \
  --url https://api.zapsterapi.com/v1/wa/instances/{instance_id}/qrcode \
  --header 'Authorization: Bearer <token>'
This response does not have an example.

Este endpoint permite capturar o QR Code de uma instância para autenticação no WhatsApp. Ele retorna a imagem no formato image/png, permitindo exibi-la diretamente em uma tag <img /> no HTML, se necessário. Para acessar este recurso, é obrigatório fornecer um token de acesso, que pode ser passado no cabeçalho da requisição ou na query string.

Para utilizar este endpoint, é necessário fornecer um token de acesso válido. A forma recomendada é enviá-lo no cabeçalho da requisição. Opcionalmente, ele pode ser passado na URL como query string, mas isso expõe o token e não é recomendado.

​
Usando o Token na Query String ⚠️ (Caso de Uso Específico)

<img src="https://api.zapsterapi.com/v1/wa/instances/{instance_id}/qrcode?access_token=SEU_TOKEN_AQUI" />

⚠️ Importante: O uso do token na URL pode expô-lo em logs de servidores e históricos de navegadores, o que representa um risco de segurança. Sempre prefira a autenticação via cabeçalho HTTP.

🚀 Por que essa opção está disponível? A renderização do QR Code via query string foi criada para permitir que o cliente compartilhe o link diretamente com seu usuário final, usando um token temporário. Dessa forma, o usuário pode simplesmente abrir o link no navegador, visualizar o QR Code e conectar a instância. Essa funcionalidade pode ser útil em cenários onde o cliente final não tem acesso ao painel da API, mas precisa conectar a conta do WhatsApp rapidamente.

​
❌ QR Code Indisponível

Se a instância já estiver conectada ou o QR Code não estiver disponível, a API retornará um erro:

{
  "errors": [
    {
      "code": "qrcode_unavailable",
      "message": "The instance's QR code is not available. This might be because your instance is already connected."
    }
  ]
}

​
📡 QR Code em Tempo Real

Se deseja atualizar o QR Code em tempo real sem que seu usuário precise sair da sua plataforma, recomendamos utilizar os eventos da instância para acompanhar as atualizações.

Para isso, você pode configurar um webhook para escutar o evento instance.qrcode. Sempre que o QR Code da sua instância for atualizado, seu sistema receberá uma notificação automática, permitindo que você atualize a exibição do QR Code em tempo real e garanta uma experiência fluida para o usuário.

​
📌 Considerações Finais

  • O QR Code muda constantemente, então é necessário atualizar periodicamente até a conexão ser estabelecida.
  • Instâncias conectadas não possuem QR Code disponível.
  • Para segurança, evite expor tokens na URL; prefira enviá-los via cabeçalho HTTP.
  • Se for utilizar a query string, certifique-se de que o token seja temporário para evitar riscos de exposição.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
instance_id
string
required

Obrigatório se instance_id não estiver presente no body.

Query Parameters

​
access_token
string

Token de acesso

Response

200
image/png
Success

The response is of type file.

Excluindo InstânciaObtendo Cód. Pareamento