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

# Guia Rápido

> Comece a usar a Wapizap API em 5 minutos

# Guia Rápido - 5 Minutos

Este guia vai te ensinar a criar sua primeira instância WhatsApp e enviar sua primeira mensagem usando a Wapizap API.

## Pré-requisitos

<Check>Conta criada em [dashboard.wapizap.com](https://dashboard.wapizap.com/register)</Check>
<Check>API Key gerada no painel</Check>

## Passo 1: Obter sua API Key

1. Acesse o [Dashboard Wapizap](https://dashboard.wapizap.com)
2. Vá em **Configurações → API Keys**
3. Clique em **Gerar Nova API Key**
4. Copie e guarde sua chave em local seguro

<Warning>
  **Importante:** Sua API Key é exibida apenas uma vez. Guarde-a em local seguro e nunca compartilhe publicamente.
</Warning>

```bash theme={null}
# Sua API Key terá este formato:
sk_live_1234567890abcdefghijklmnopqrstuvwxyz
```

***

## Passo 2: Criar sua Primeira Instância

Uma instância representa uma conexão WhatsApp. Vamos criar uma:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.wapizap.com/api/v2/instances \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer sk_live_SEU_TOKEN_AQUI" \
    -d '{
      "name": "minha-primeira-instancia",
      "webhookUrl": "https://seu-webhook.com/wapizap"
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.wapizap.com/api/v2/instances', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer sk_live_SEU_TOKEN_AQUI'
    },
    body: JSON.stringify({
      name: 'minha-primeira-instancia',
      webhookUrl: 'https://seu-webhook.com/wapizap'
    })
  });

  const instance = await response.json();
  console.log('Instância criada:', instance);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://api.wapizap.com/api/v2/instances',
      headers={
          'Content-Type': 'application/json',
          'Authorization': 'Bearer sk_live_SEU_TOKEN_AQUI'
      },
      json={
          'name': 'minha-primeira-instancia',
          'webhookUrl': 'https://seu-webhook.com/wapizap'
      }
  )

  instance = response.json()
  print('Instância criada:', instance)
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init('https://api.wapizap.com/api/v2/instances');

  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_POST => true,
      CURLOPT_HTTPHEADER => [
          'Content-Type: application/json',
          'Authorization: Bearer sk_live_SEU_TOKEN_AQUI'
      ],
      CURLOPT_POSTFIELDS => json_encode([
          'name' => 'minha-primeira-instancia',
          'webhookUrl' => 'https://seu-webhook.com/wapizap'
      ])
  ]);

  $response = curl_exec($ch);
  $instance = json_decode($response, true);

  echo 'Instância criada: ' . print_r($instance, true);
  curl_close($ch);
  ?>
  ```
</CodeGroup>

### Resposta de Sucesso

```json theme={null}
{
  "success": true,
  "data": {
    "id": "inst_abc123xyz",
    "name": "minha-primeira-instancia",
    "status": "disconnected",
    "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANS...",
    "pairingCode": "K24J8N3R",
    "createdAt": "2026-01-14T10:30:00Z"
  }
}
```

<Tip>
  Guarde o `id` da instância (`inst_abc123xyz`). Você vai precisar dele para enviar mensagens!
</Tip>

***

## Passo 3: Conectar ao WhatsApp

Existem **2 formas** de conectar:

<Tabs>
  <Tab title="QR Code (Recomendado)">
    1. Copie o campo `qrCode` da resposta anterior
    2. Cole em um visualizador de imagem base64 ou salve como arquivo `.png`
    3. No WhatsApp do seu celular:
       * Vá em **Configurações → Aparelhos conectados**
       * Toque em **Conectar um aparelho**
       * Escaneie o QR code exibido

    <Info>O QR code expira em 60 segundos. Se expirar, faça uma nova requisição ao endpoint `/instances/{id}/qrcode`</Info>
  </Tab>

  <Tab title="Código de Pareamento">
    1. Copie o `pairingCode` da resposta (ex: `K24J8N3R`)
    2. No WhatsApp do seu celular:
       * Vá em **Configurações → Aparelhos conectados**
       * Toque em **Conectar usando número de telefone**
       * Digite o código de pareamento

    <Info>O código de pareamento também expira em 60 segundos</Info>
  </Tab>
</Tabs>

### Verificar Status da Conexão

Após escanear o QR code ou inserir o código, verifique se conectou:

```bash theme={null}
curl -X GET https://api.wapizap.com/api/v2/instances/inst_abc123xyz/status \
  -H "Authorization: Bearer sk_live_SEU_TOKEN_AQUI"
```

**Resposta quando conectado:**

```json theme={null}
{
  "success": true,
  "data": {
    "status": "connected",
    "phone": "5511999999999",
    "profilePicture": "https://...",
    "profileName": "Meu WhatsApp"
  }
}
```

<Check>**Pronto!** Sua instância está conectada e pronta para enviar mensagens 🎉</Check>

***

## Passo 4: Enviar sua Primeira Mensagem

Agora vamos enviar uma mensagem de texto:

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.wapizap.com/api/v2/messages \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer sk_live_SEU_TOKEN_AQUI" \
    -d '{
      "instanceId": "inst_abc123xyz",
      "to": "5511999999999",
      "type": "text",
      "text": "Olá! Esta é minha primeira mensagem via Wapizap API 🚀"
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.wapizap.com/api/v2/messages', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer sk_live_SEU_TOKEN_AQUI'
    },
    body: JSON.stringify({
      instanceId: 'inst_abc123xyz',
      to: '5511999999999',
      type: 'text',
      text: 'Olá! Esta é minha primeira mensagem via Wapizap API 🚀'
    })
  });

  const message = await response.json();
  console.log('Mensagem enviada:', message);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://api.wapizap.com/api/v2/messages',
      headers={
          'Content-Type': 'application/json',
          'Authorization': 'Bearer sk_live_SEU_TOKEN_AQUI'
      },
      json={
          'instanceId': 'inst_abc123xyz',
          'to': '5511999999999',
          'type': 'text',
          'text': 'Olá! Esta é minha primeira mensagem via Wapizap API 🚀'
      }
  )

  message = response.json()
  print('Mensagem enviada:', message)
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init('https://api.wapizap.com/api/v2/messages');

  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_POST => true,
      CURLOPT_HTTPHEADER => [
          'Content-Type: application/json',
          'Authorization: Bearer sk_live_SEU_TOKEN_AQUI'
      ],
      CURLOPT_POSTFIELDS => json_encode([
          'instanceId' => 'inst_abc123xyz',
          'to' => '5511999999999',
          'type' => 'text',
          'text' => 'Olá! Esta é minha primeira mensagem via Wapizap API 🚀'
      ])
  ]);

  $response = curl_exec($ch);
  $message = json_decode($response, true);

  echo 'Mensagem enviada: ' . print_r($message, true);
  curl_close($ch);
  ?>
  ```
</CodeGroup>

### Resposta de Sucesso

```json theme={null}
{
  "success": true,
  "data": {
    "id": "msg_xyz789abc",
    "instanceId": "inst_abc123xyz",
    "to": "5511999999999",
    "type": "text",
    "text": "Olá! Esta é minha primeira mensagem via Wapizap API 🚀",
    "status": "sent",
    "timestamp": 1705233000,
    "key": {
      "remoteJid": "5511999999999@s.whatsapp.net",
      "fromMe": true,
      "id": "3EB0XXXXX"
    }
  }
}
```

<Success>
  **Parabéns!** 🎉 Você enviou sua primeira mensagem via Wapizap API!
</Success>

***

## Formato do Número

<Warning>
  **Importante:** O número deve estar no formato internacional **sem símbolos**:
</Warning>

| ❌ Incorreto       | ✅ Correto     |
| ----------------- | ------------- |
| +55 11 99999-9999 | 5511999999999 |
| (11) 99999-9999   | 5511999999999 |
| 11999999999       | 5511999999999 |

**Formato:** `[código do país][DDD][número]`

Exemplos:

* Brasil: `5511999999999`
* Portugal: `351912345678`
* EUA: `14155551234`

***

## Próximos Passos

Agora que você já sabe o básico, explore mais funcionalidades:

<CardGroup cols={2}>
  <Card title="Enviar Mídias" icon="image" href="/guides/sending-messages#enviar-imagem">
    Aprenda a enviar imagens, vídeos, áudios e documentos
  </Card>

  <Card title="Gerenciar Grupos" icon="users" href="/guides/managing-groups">
    Crie grupos, adicione participantes e gerencie permissões
  </Card>

  <Card title="Configurar Webhooks" icon="webhook" href="/guides/webhooks-setup">
    Receba notificações em tempo real de mensagens recebidas
  </Card>

  <Card title="API Reference Completa" icon="book" href="/api-v2/overview">
    Explore todos os 60+ endpoints disponíveis
  </Card>
</CardGroup>

***

## Precisa de Ajuda?

<CardGroup cols={3}>
  <Card title="Discord" icon="discord" href="https://discord.gg/wapizap">
    Comunidade ativa
  </Card>

  <Card title="Email" icon="envelope" href="mailto:support@wapizap.com">
    [support@wapizap.com](mailto:support@wapizap.com)
  </Card>

  <Card title="FAQ" icon="question" href="/support/faq">
    Perguntas frequentes
  </Card>
</CardGroup>

***

## Limites de Taxa (Rate Limits)

Para garantir estabilidade, a API tem os seguintes limites:

| Endpoint         | Limite                      |
| ---------------- | --------------------------- |
| Criar instância  | 10 por hora                 |
| Enviar mensagens | 30 por minuto por instância |
| Listar chats     | 60 por minuto               |
| Outros endpoints | 120 por minuto              |

<Info>
  Precisa de limites maiores? Entre em contato pelo [suporte](mailto:support@wapizap.com) ou faça upgrade do seu plano.
</Info>