> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vzaps.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Instalação

> Instale, autentique e configure o SDK Python oficial da VZaps

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

| Recurso | Versão           |
| ------- | ---------------- |
| Python  | 3.10 ou superior |

## Instalar

```bash theme={null}
pip install vzaps
```

## Criar o cliente

```python theme={null}
from vzaps import VZapsClient

client = VZapsClient(
    client_token="your-client-token",
    client_secret="your-client-secret",
)
```

Aplicações assíncronas podem usar `AsyncVZapsClient`:

```python theme={null}
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

| Credencial       | Onde usar                 | Descrição                                                        |
| ---------------- | ------------------------- | ---------------------------------------------------------------- |
| `client_token`   | Construtor do cliente     | Token de cliente da conta, também enviado como `X-Client-Token`. |
| `client_secret`  | Construtor do cliente     | Segredo usado pelo SDK para obter e renovar JWTs.                |
| `instance_token` | Cada chamada de instância | Token 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.

```python theme={null}
access_token = client.auth.get_access_token()
```

## Opções do cliente

| Opção                | Padrão        | Uso                                          |
| -------------------- | ------------- | -------------------------------------------- |
| `timeout`            | `30.0`        | Timeout HTTP em segundos ou `httpx.Timeout`. |
| `limits`             | `None`        | `httpx.Limits` opcional.                     |
| `token_skew_seconds` | `60.0`        | Renovar JWT antes da expiração real.         |
| `user_agent`         | Padrão do SDK | Header HTTP `User-Agent`.                    |

## Variáveis de ambiente

```bash theme={null}
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

* Siga o [Starter Guide](/pt-BR/sdk/python/starter-guide).
* Veja [Mensagens](/pt-BR/sdk/python/messages) para métodos de envio.
* Veja [Realtime](/pt-BR/sdk/python/realtime) para assinaturas WebSocket.