Pular para o conteúdo principal
O SDK Python oficial da VZaps encapsula autenticação, chamadas HTTP, headers obrigatórios, eventos realtime e os principais recursos da API pública. Use em backends Python, CLIs, jobs, notebooks e automações server-to-server.

​
Requisitos

RecursoVersão
Python3.10 ou superior

​
Instalar

pip install vzaps

​
Criar o cliente

from vzaps import VZapsClient

client = VZapsClient(
    client_token="your-client-token",
    client_secret="your-client-secret",
)
Aplicações assíncronas podem usar AsyncVZapsClient: 
from vzaps import AsyncVZapsClient

async with AsyncVZapsClient(
    client_token="your-client-token",
    client_secret="your-client-secret",
) as client:
    instances = await client.instances.list()

​
Credenciais

CredencialOnde usarDescrição
client_tokenConstrutor do clienteToken de cliente da conta, também enviado como X-Client-Token.
client_secretConstrutor do clienteSegredo usado pelo SDK para obter e renovar JWTs.
instance_tokenCada chamada de instânciaToken da instância, enviado como X-Instance-Token.
Não exponha client_secret ou instance_token em front-ends públicos.

​
Autenticação automática

O SDK obtém um JWT com client_token e client_secret, cacheia em memória e renova antes de expirar. 
access_token = client.auth.get_access_token()

​
Opções do cliente

OpçãoPadrãoUso
timeout30.0Timeout HTTP em segundos ou httpx.Timeout.
limitsNonehttpx.Limits opcional.
token_skew_seconds60.0Renovar JWT antes da expiração real.
user_agentPadrão do SDKHeader HTTP User-Agent.

​
Variáveis de ambiente

VZAPS_CLIENT_TOKEN=your-client-token
VZAPS_CLIENT_SECRET=your-client-secret
VZAPS_INSTANCE_ID=VZ...
VZAPS_INSTANCE_TOKEN=your-instance-token

​
Próximos passos