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

# Início rápido

> Faça sua primeira requisição em menos de 5 minutos

Este guia vai te ajudar a enviar sua primeira mensagem via WhatsApp usando a Oxenty API.

## Pré-requisitos

<Check>
  Conta criada na [Oxenty](https://oxenty.api.br)
</Check>

<Check>
  API Key gerada no Dashboard
</Check>

<Check>
  Número de telefone para testar
</Check>

***

## Passo 1: Obter sua API Key

<Steps>
  <Step title="Acesse o Dashboard">
    Faça login em [oxenty.api.br/login](https://oxenty.api.br/login)
  </Step>

  <Step title="Navegue até API Keys">
    Menu lateral → **API Keys**
  </Step>

  <Step title="Crie uma nova key">
    Clique em **"Criar Nova Key"**, defina um nome e copie o valor gerado
  </Step>
</Steps>

<Warning>
  Guarde sua API Key em local seguro. Ela não será exibida novamente.
</Warning>

***

## Passo 2: Criar uma sessão

Uma **sessão** representa uma conexão com o WhatsApp. Você precisa criar e conectar uma sessão antes de enviar mensagens.

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -X POST "https://api.oxenty.api.br/api/sessions" \
    -H "X-API-Key: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "minha-primeira-sessao"
    }'
  ```

  ```typescript TypeScript theme={"system"}
  const response = await fetch('https://api.oxenty.api.br/api/sessions', {
    method: 'POST',
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'minha-primeira-sessao',
    }),
  });

  const session = await response.json();
  console.log('Sessão criada:', session.id);
  ```

  ```python Python theme={"system"}
  import requests

  response = requests.post(
    'https://api.oxenty.api.br/api/sessions',
    headers={
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    json={
      'name': 'minha-primeira-sessao',
    }
  )

  session = response.json()
  print(f"Sessão criada: {session['id']}")
  ```
</CodeGroup>

**Resposta:**

```json theme={"system"}
{
  "id": "sess_abc123",
  "name": "minha-primeira-sessao",
  "status": "disconnected",
  "createdAt": "2024-01-15T10:00:00.000Z"
}
```

***

## Passo 3: Conectar a sessão

Para conectar a sessão no WhatsApp, obtenha o QR Code e escaneie com o celular:

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -X GET "https://api.oxenty.api.br/api/sessions/sess_abc123/qrcode" \
    -H "X-API-Key: YOUR_API_KEY"
  ```

  ```typescript TypeScript theme={"system"}
  const response = await fetch(
    'https://api.oxenty.api.br/api/sessions/sess_abc123/qrcode',
    {
      method: 'GET',
      headers: {
        'X-API-Key': 'YOUR_API_KEY',
      },
    }
  );

  const { qrCode } = await response.json();
  console.log('Escaneie o QR Code:', qrCode);
  ```
</CodeGroup>

**Resposta:**

```json theme={"system"}
{
  "sessionId": "sess_abc123",
  "qrCode": "2@ABC123...",
  "status": "QRCODE",
  "message": "Escaneie o QR Code para conectar."
}
```

<Note>
  O campo `qrCode` deve ser renderizado como QR Code (imagem) no seu frontend.
</Note>

***

## Passo 4: Verificar conexão

Após escanear o QR Code, verifique se a sessão conectou:

```bash theme={"system"}
curl -X GET "https://api.oxenty.api.br/api/sessions/sess_abc123" \
  -H "X-API-Key: YOUR_API_KEY"
```

**Resposta quando conectado:**

```json theme={"system"}
{
  "id": "sess_abc123",
  "name": "minha-primeira-sessao",
  "status": "connected",
  "phone": "5511999999999",
  "connectedAt": "2024-01-15T10:05:00.000Z"
}
```

***

## Passo 5: Enviar sua primeira mensagem

Agora você pode enviar mensagens:

<CodeGroup>
  ```bash cURL theme={"system"}
  curl -X POST "https://api.oxenty.api.br/api/messages/text" \
    -H "X-API-Key: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "sessionId": "sess_abc123",
      "to": "5511888888888",
      "text": "Olá! Esta é minha primeira mensagem via Oxenty API!"
    }'
  ```

  ```typescript TypeScript theme={"system"}
  const response = await fetch('https://api.oxenty.api.br/api/messages/text', {
    method: 'POST',
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      sessionId: 'sess_abc123',
      to: '5511888888888',
      text: 'Olá! Esta é minha primeira mensagem via Oxenty API!',
    }),
  });

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

  ```python Python theme={"system"}
  import requests

  response = requests.post(
    'https://api.oxenty.api.br/api/messages/text',
    headers={
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    json={
      'sessionId': 'sess_abc123',
      'to': '5511888888888',
      'text': 'Olá! Esta é minha primeira mensagem via Oxenty API!',
    }
  )

  message = response.json()
  print(f"Mensagem enviada: {message['messageId']}")
  ```
</CodeGroup>

**Resposta:**

```json theme={"system"}
{
  "messageId": "msg_xyz789",
  "status": "sent",
  "to": "5511888888888@s.whatsapp.net",
  "timestamp": "2024-01-15T10:10:00.000Z"
}
```

<Check>
  **Pronto.** Você acabou de enviar sua primeira mensagem via Oxenty API.
</Check>