Exemplos - VZaps Docs

O repositório oficial do SDK Python inclui scripts executáveis que espelham os fluxos documentados neste guia.

Repositório no GitHub

Todos os exemplos ficam na pasta examples/: github.com/VZaps/vzaps-sdk-python A pasta inclui requirements.txt para o pacote PyPI publicado (vzaps) e carregamento compartilhado de credenciais em _env.py. Veja o examples/README.md no repositório para a lista completa de arquivos.

O que está incluído

Arquivo	Tema
`01_auth_and_list_instances.py`	Autenticação e listagem de instâncias
`02_create_instance.py`	Criar instância
`03_instance_subscription.py`	Assinatura e billing
`04_session_and_pairing.py`	Status da sessão, QR e código de pareamento
`05_configure_webhook.py`	Configuração de webhook
`06_realtime_subscribe.py`	Assinatura realtime via WebSocket
`07_send_text_message.py`	Enviar mensagem de texto
`08_send_media_and_interactive.py`	Mídia, botões e lista
`09_send_poll_reaction_and_chat_actions.py`	Enquete, reação e ações de chat
`10_queues.py`	Filas de mensagens e operações
`11_typebot_and_chatwoot.py`	TypeBot e Chatwoot

Opção A — só a pasta examples (recomendado)

Você não precisa clonar o repositório inteiro do SDK.

Baixe apenas a pasta examples/ com Download ZIP no GitHub, ou execute:

npx --yes degit VZaps/vzaps-sdk-python/examples vzaps-python-examples
cd vzaps-python-examples

Instale as dependências, configure as variáveis de ambiente e execute:

pip install -r requirements.txt
export VZAPS_CLIENT_TOKEN=seu-client-token
export VZAPS_CLIENT_SECRET=seu-client-secret
export VZAPS_INSTANCE_ID=VZ...
export VZAPS_INSTANCE_TOKEN=token-da-instancia
python 07_send_text_message.py

Opção B — sparse checkout

git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-python.git
cd vzaps-sdk-python
git sparse-checkout set examples
cd examples
pip install -r requirements.txt
python 07_send_text_message.py

Opção C — clone completo do repositório

git clone https://github.com/VZaps/vzaps-sdk-python.git
cd vzaps-sdk-python
pip install -e .
python examples/07_send_text_message.py

Use pip install -e . quando estiver desenvolvendo o SDK localmente.

Próximos passos

Siga o Guia inicial para um passo a passo completo.
Veja Mensagens para todos os tipos de envio.

​Repositório no GitHub

​O que está incluído

​Opção A — só a pasta examples (recomendado)

​Opção B — sparse checkout

​Opção C — clone completo do repositório

​Próximos passos