Skip to content

Início Rápido

Este guia vai te ajudar a começar a usar a API do ZapFlare em poucos minutos.

Pré-requisitos

Antes de começar, você precisa:

  1. Conta no ZapFlare: Crie sua conta gratuita
  2. API Key: Disponível no Dashboard
  3. WhatsApp: Número de telefone com WhatsApp ativo

Passo 1: Obter API Key

Após criar sua conta, acesse o dashboard e gere uma nova API Key:

  1. Faça login no Dashboard
  2. Navegue até API Keys
  3. Clique em Gerar Nova Chave
  4. Copie e guarde sua chave com segurança

Importante

A API Key é exibida apenas uma vez. Guarde-a em um local seguro!

Passo 2: Criar uma Instância

Uma instância representa uma conexão com o WhatsApp. Você pode criar via dashboard ou API:

Via Dashboard

  1. Acesse Instâncias no menu
  2. Clique em Nova Instância
  3. Preencha o nome e descrição
  4. Configure o webhook (opcional)

Via API

⚠️ NOTA: A criação de instâncias via API ainda está em desenvolvimento. Por enquanto, use o Dashboard para criar e gerenciar instâncias.

Passo 3: Conectar ao WhatsApp

Após criar a instância, você precisa escaneá-la com o WhatsApp:

  1. Abra o WhatsApp no seu celular
  2. Vá em Configurações > Dispositivos Conectados
  3. Toque em Conectar Dispositivo
  4. Escaneie o QR Code exibido

Dica

O QR Code expira em 60 segundos. Se expirar, faça uma nova requisição para obter um novo código.

Passo 4: Enviar Primeira Mensagem

Com a instância conectada, você já pode enviar mensagens:

bash
curl -X POST https://api.zapflare.io/v1/messages/send \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999999999",
    "text": "Olá! Esta é minha primeira mensagem via ZapFlare API 🚀"
  }'

Exemplos de Código

Node.js

javascript
const axios = require('axios');

const API_KEY = 'sua_api_key';
const BASE_URL = 'https://api.zapflare.io/v1';

async function sendMessage(to, text) {
  try {
    const response = await axios.post(
      `${BASE_URL}/messages/send`,
      {
        to: to,
        text: text
      },
      {
        headers: {
          'Authorization': `Bearer ${API_KEY}`,
          'Content-Type': 'application/json'
        }
      }
    );
    
    console.log('Mensagem enviada:', response.data);
  } catch (error) {
    console.error('Erro ao enviar mensagem:', error.response?.data || error.message);
  }
}

// Usar
sendMessage('5511999999999', 'Olá do Node.js!');

Python

python
import requests

API_KEY = 'sua_api_key'
BASE_URL = 'https://api.zapflare.io/v1'

def send_message(to, text):
    url = f"{BASE_URL}/messages/send"
    
    headers = {
        'Authorization': f'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
    
    data = {
        'to': to,
        'text': text
    }
    
    response = requests.post(url, json=data, headers=headers)
    
    if response.status_code == 200:
        print('Mensagem enviada:', response.json())
    else:
        print('Erro:', response.json())

# Usar
send_message('5511999999999', 'Olá do Python!')

PHP

php
<?php
$apiKey = 'sua_api_key';
$baseUrl = 'https://api.zapflare.io/v1';

function sendMessage($to, $text) {
    global $apiKey, $baseUrl;
    
    $url = "$baseUrl/messages/send";
    
    $data = [
        'to' => $to,
        'text' => $text
    ];
    
    $options = [
        'http' => [
            'header' => [
                "Authorization: Bearer $apiKey",
                "Content-Type: application/json"
            ],
            'method' => 'POST',
            'content' => json_encode($data)
        ]
    ];
    
    $context = stream_context_create($options);
    $result = file_get_contents($url, false, $context);
    
    if ($result === FALSE) {
        echo "Erro ao enviar mensagem\n";
    } else {
        echo "Mensagem enviada: $result\n";
    }
}

// Usar
sendMessage('5511999999999', 'Olá do PHP!');
?>

Próximos Passos

Agora que você já enviou sua primeira mensagem, explore mais recursos:

Desenvolvido com ❤️ pela equipe ZapFlare