Evandro Fonseca Junior
ef521876eb
Updated ABACATEPAY_SETUP.md with comprehensive setup guide, including environment variables, API key instructions, webhook configuration, donation flow, and field details for better integration clarity. Added required fields (phone, CPF/CNPJ) to the donation form in app/[locale]/apoiar/page.tsx to collect essential donor information and improve compliance. This ensures smoother setup and more robust donation processing.
71 lines
1.9 KiB
Markdown
71 lines
1.9 KiB
Markdown
# Configuração - Sistema de Doações PIX via AbacatePay
|
|
|
|
## Variáveis de Ambiente
|
|
|
|
### Desenvolvimento/Teste
|
|
|
|
Crie o arquivo `.env.local` na raiz do projeto:
|
|
|
|
```env
|
|
# Chave de API para ambiente de teste
|
|
ABACATE_TEST_APIKEY=abc_test_sua_chave_aqui
|
|
|
|
# URL base da aplicação
|
|
NEXT_PUBLIC_BASE_URL=http://localhost:3000
|
|
```
|
|
|
|
### Produção
|
|
|
|
```env
|
|
# Chave de API para ambiente de produção
|
|
ABACATE_APIKEY=abc_live_sua_chave_aqui
|
|
|
|
# URL base da aplicação
|
|
NEXT_PUBLIC_BASE_URL=https://seudominio.com
|
|
```
|
|
|
|
## Como Funciona
|
|
|
|
O sistema automaticamente escolhe a chave correta baseado no ambiente:
|
|
|
|
- **Desenvolvimento**: Usa `ABACATE_TEST_APIKEY`
|
|
- **Produção**: Usa `ABACATE_APIKEY` (quando `NODE_ENV=production`)
|
|
|
|
## Obtenção da Chave API
|
|
|
|
1. Acesse https://abacatepay.com
|
|
2. Crie uma conta gratuita
|
|
3. Vá em "Configurações" > "API Keys"
|
|
4. Copie sua chave de teste (começa com `abc_test_...`)
|
|
5. Cole no arquivo `.env.local`
|
|
|
|
## Endpoint do Webhook
|
|
|
|
Configure no painel do AbacatePay:
|
|
|
|
**Desenvolvimento**: `http://localhost:3000/api/webhooks/abacatepay`
|
|
**Produção**: `https://seudominio.com/api/webhooks/abacatepay`
|
|
|
|
## Estrutura do Sistema
|
|
|
|
### Fluxo de Doação
|
|
|
|
1. Usuário clica em "Apoiar com PIX"
|
|
2. Preenche formulário: nome (obrigatório), email (opcional), mensagem (opcional)
|
|
3. Sistema gera QR Code PIX via endpoint `/pixQrCode/create`
|
|
4. Usuário escaneia QR Code ou copia código PIX
|
|
5. Pagamento é processado no app bancário
|
|
6. Webhook confirma pagamento automaticamente
|
|
7. Dados são registrados para futuros agradecimentos e benefícios
|
|
|
|
### Campos Coletados
|
|
|
|
- **Nome**: obrigatório (mínimo 3 caracteres) - para dar os devidos agradecimentos
|
|
- **Email**: opcional - para enviar agradecimento por email
|
|
- **Mensagem**: opcional (máximo 280 caracteres) - mensagem personalizada para a equipe
|
|
|
|
### Expiração
|
|
|
|
- QR Code expira em 10 minutos
|
|
- Timer exibido no modal para o usuário acompanhar
|