Pular para o conteúdo principal
O repositório oficial do SDK TypeScript inclui arquivos .ts 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-typescript A pasta inclui um package.json pequeno que instala o pacote npm publicado (@vzaps/sdk) e o tsx. Veja o examples/README.md no repositório para a lista completa de arquivos.

​
O que está incluído

ArquivoTema
01-auth-and-list-instances.tsAutenticação e listagem de instâncias
02-create-instance.tsCriar instância
03-instance-subscription.tsAssinatura e billing
04-session-and-pairing.tsStatus da sessão, QR e código de pareamento
05-configure-webhook.tsConfiguração de webhook
06-realtime-subscribe.tsAssinatura realtime via WebSocket
07-send-text-message.tsEnviar mensagem de texto
08-send-media-and-interactive.tsMídia, botões e lista
09-send-poll-reaction-and-chat-actions.tsEnquete, reação e ações de chat
10-queues.tsFilas de mensagens e operações
11-typebot-and-chatwoot.tsTypeBot e Chatwoot

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

Você não precisa clonar o repositório inteiro do SDK.
  1. Baixe apenas a pasta examples/ com Download ZIP no GitHub, ou execute:
npx --yes degit VZaps/vzaps-sdk-typescript/examples vzaps-ts-examples
cd vzaps-ts-examples
  1. Instale as dependências, edite as constantes no arquivo desejado e execute:
npm install
npx tsx 07-send-text-message.ts

​
Opção B — sparse checkout

git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript
git sparse-checkout set examples
cd examples
npm install
npx tsx 07-send-text-message.ts

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

git clone https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript/examples
npm install
npx tsx 07-send-text-message.ts
Ao desenvolver o SDK, faça build e link do pacote local primeiro. Veja o README do repositório para setup de contribuidores.

​
Próximos passos