PEPINO ZAPdocs
Referência da APIInstancias

Stream SSE de QR Code e status

Ver como Markdown
GET
/v1/instances/{id}/qr

Abre um stream Server-Sent Events (SSE) com o QR Code de pareamento e as transicoes de status, ao vivo. Ao conectar, ja solicita ao worker que gere o QR na hora (sem esperar o ciclo de reconciliacao). Como o EventSource do navegador nao envia headers, este endpoint autentica via parametro de query token em vez do header Authorization — passe a propria API key OU o token efemero emitido por POST /v1/instances/{id}/qr-token. Emite quatro tipos de evento: "ready" (handshake inicial, confirma que o stream esta vivo), "qr" (cada novo QR Code gerado, com {code, at}; renderize o code como QR Code), "status" (transicoes de estado da instancia, ex. CONNECTED/PAIRED — pare ao conectar) e "ping" (keepalive vazio a cada 25s para atravessar proxies). OBSERVACAO: antivirus e proxies corporativos que bufferizam streams podem impedir a entrega do QR; nesse caso prefira o endpoint de poll (GET /v1/instances/{id}/qr/poll).

Path Parameters

id*string

Identificador da instancia.

Query Parameters

token*string

API key passada na query string (apenas neste endpoint SSE).

Response Body

text/event-stream

application/json

application/json

application/json

curl -X GET "https://example.com/v1/instances/cm5x8a9k20001abc123def456/qr?token=pzk_live_xxxxxxxxxxxxxxxx"
"string"
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}