API
/ Conexão
/ Obter QR Code
GET
https://api.instvia.com/api/v1/instances/dac3a956-4e8b-4d76-8caf-fed98dfc8b05/qrcode?format=png
Obter QR Code
Retorna a string de pareamento e a imagem PNG em data URI. Use `?format=png` para receber o binário PNG puro. Escaneie em WhatsApp → Aparelhos conectados.
Parâmetros (query)
Nome
Exemplo
Obrigatório
Descrição
format
png
Não
Se `png`, responde `image/png` em vez de JSON.
Parâmetros de path
Nome Exemplo
instance
dac3a956-4e8b-4d76-8caf-fed98dfc8b05
Campos
Campo
Tipo
Descrição
qr
string|null
Payload de pareamento (quando disponível).
image
string|null
PNG em data URI para exibir no front.
Request
Headers
Copiar
{
"Accept": "application/json",
"Authorization": "Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef"
}
Exemplos de código
cURL
JavaScript
PHP
Copiar
curl -sS -X GET "https://api.instvia.com/api/v1/instances/dac3a956-4e8b-4d76-8caf-fed98dfc8b05/qrcode?format=png" \
-H "Accept: application/json" \
-H "Authorization: Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef"
Copiar
const response = await fetch('https://api.instvia.com/api/v1/instances/dac3a956-4e8b-4d76-8caf-fed98dfc8b05/qrcode?format=png', {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef',
}
});
const data = await response.json();
console.log(data);
Copiar
<?php
$ch = curl_init('https://api.instvia.com/api/v1/instances/dac3a956-4e8b-4d76-8caf-fed98dfc8b05/qrcode?format=png');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Accept: application/json',
'Authorization: Bearer sk_live_0123456789abcdef0123456789abcdef0123456789abcdef',
],
]);
$body = curl_exec($ch);
curl_close($ch);
\$data = json_decode($body, true);
Response 200
Copiar
{
"success": true,
"data": {
"status": "QR_REQUIRED",
"qr": "2@abcdef...",
"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
}
Response 409
Copiar
{
"success": false,
"error": {
"code": "QR_NOT_READY",
"message": "QR code is not available yet. Call connect first."
}
}