Guia rápido
Sumário
1 Cadastrar sua empresa
- Acesse a página /cadastro.
- Selecione o tipo: Pessoa jurídica (CNPJ) ou Pessoa física (CPF).
- Preencha nome/razão social, email, documento e telefone.
- Marque o aceite dos Termos de Uso e Política de Privacidade.
- Clique em Solicitar cadastro.
2 Ativar seu acesso
- Quando o admin aprovar, você recebe um email com link de ativação.
- Abre o link e cria uma senha (mínimo 8 caracteres).
- Você é logado automaticamente no painel da empresa.
3 Conectar Mercado Pago
Pra começar a receber PIX, você precisa autorizar a plataforma a operar em nome da sua conta MP.
- No painel da empresa, vai em Mercado Pago (menu lateral).
- Clica em Conectar com Mercado Pago.
- Você é redirecionado pro MP. Loga com sua conta MP normal e autoriza.
- Volta pro painel com badge verde Conectado.
Importante: chave PIX cadastrada
Sua conta MP precisa ter pelo menos uma chave PIX cadastrada no app do Mercado Pago (CPF, CNPJ, email, telefone ou aleatória). Sem chave PIX, o MP rejeita a criação de cobrança com erro "collector user without key".
4 Criar a primeira cobrança
Pelo painel:
- Aba Dashboard ou Cobranças → botão Nova cobrança.
- Preenche: valor (ex: R$ 1,00 pra teste), descrição, e validade do QR (default 30min).
- Clica Criar. O sistema gera o QR e o código copia-cola.
- Aparece um modal com o link
/pay/<id>que você pode mandar pro pagador.
5 Receber pagamento e ver no painel
- O pagador escaneia o QR (ou cola o código) no app do banco dele.
- Mercado Pago confirma o pagamento.
- Em ~1 segundo, o painel atualiza automaticamente (Socket.IO real-time):
- Status da cobrança vira approved
- Se você ativou notificação instantânea → email chega na hora
- Webhook outbound dispara (se configurado)
- O dinheiro cai na sua conta Mercado Pago, descontados:
- Taxa do MP (~0,99% PIX)
- Taxa da plataforma (2,99%, com mínimo R$ 0,49 e máximo R$ 9,99)
6 Cadastrar dispositivo IoT
Se você vai usar ESP32 ou outra placa embarcada com tela:
- Aba Dispositivos → Novo dispositivo.
- Preenche nome (ex: "Caixa 1 - Loja Centro"), tipo (esp32) e local.
- O sistema gera um device token (única vez visível — copie agora!).
- Use esse token no firmware da placa, no header
X-Device-Token.
Veja o Manual ESP32 pra detalhes do hardware e firmware.
7 Configurar webhook (opcional)
Se você quer que seu sistema próprio receba notificações em tempo real:
- Aba Webhooks → preenche a URL pública do seu sistema.
- Clica Gerar novo secret e copia o valor (única vez visível).
- Salva o secret no
.envdo seu sistema. - No seu sistema, valida o header
X-MPP-Signaturecom HMAC SHA256.
Eventos enviados: charge.created, charge.approved, charge.rejected, charge.cancelled, charge.expired.
Retry automático com backoff exponencial em caso de falha (30s, 2min, 10min, 30min, 2h, 6h).
8 Ativar relatórios e notificações
Aba Relatórios:
Notificação instantânea
- Toggle "Receber email a cada pagamento aprovado" — recomendado pro dia-a-dia.
- Email destinatário pode ser diferente do email principal.
Relatórios automáticos
7 tipos disponíveis, cada um com horário e dia configuráveis:
- Diário — resumo das últimas 24h
- Semanal — comparação com semana anterior
- Mensal — fechamento mensal com taxas detalhadas
- Erros — cobranças rejeitadas/canceladas + webhooks falhos
- Cobranças expiradas — quem abriu o QR e não pagou
- Dispositivos offline — placa sem heartbeat há > 6h
- Anomalias — volume 50%+ acima/abaixo da média
9 Integrar com seu sistema (API)
Se você tem ERP, sistema de PDV ou outro software:
- Aba API Key → copia sua chave.
- Documentação completa em /docs (Swagger UI).
- Cria cobrança via
POST /api/v1/chargescom headerX-API-Key.
Exemplo cURL:
curl -X POST 'https://SEU-DOMINIO/api/v1/charges' \
-H 'X-API-Key: SUA_API_KEY' \
-H 'Idempotency-Key: '$(uuidgen) \
-H 'Content-Type: application/json' \
-d '{"amount": 100.00, "description": "Pedido #123"}'
/llms.txt no chat — a IA lê todos os endpoints e gera código de integração correto.10 Suporte e dúvidas
- Documentação API: /docs
- Política e Termos: /privacidade
- Manual hardware ESP32: /manual-esp32
- Email de suporte:
contato@plataforma.com