Skip to main content
Para começar a usar a API Vexy Bank, você precisa obter suas credenciais de autenticação. Este guia mostra como conseguir e gerenciar suas chaves API.

​
Passo 1: Obter credenciais

Após criar sua conta e empresa na plataforma Vexy Bank, você receberá duas credenciais importantes:

​
Tipos de Credenciais

API Key (Chave Pública)

Formato: pk_live_abc123def456ghi789 ou pk_test_abc123def456ghi789Pode ser exposta no client-side quando necessário

API Secret (Chave Secreta)

Formato: sk_live_xyz789uvw012mno345 ou sk_test_xyz789uvw012mno345NUNCA exponha esta chave publicamente

​
Ambientes

PrefixoAmbienteUsoAPI Base URL
pk_live_ / sk_live_ProduçãoOperações reaishttps://api.vexybank.com

​
Passo 2: Configurar autenticação

​
Autenticação Basic

Para gerar tokens de acesso, use autenticação Basic Auth com suas credenciais: 
# Encode suas credenciais em Base64
echo -n "pk_test_abc123:sk_test_xyz789" | base64
# Resultado: cGtfdGVzdF9hYmMxMjM6c2tfdGVzdF94eXo3ODk=

​
Exemplo de Requisição

curl -X POST 'https://api.vexybank.com/api/auth' \
  -H 'Authorization: Basic cGtfdGVzdF9hYmMxMjM6c2tfdGVzdF94eXo3ODk='

​
Segurança das credenciais

Importante: Mantenha sua API Secret segura e nunca a exponha em código client-side, repositórios públicos ou logs.

​
Boas práticas

  • Use variáveis de ambiente para armazenar credenciais
  • Separe ambientes - nunca misture chaves de teste com produção
  • Rotacione chaves periodicamente
  • Limite acesso apenas aos desenvolvedores necessários
  • Monitore uso através do dashboard

​
Práticas a evitar

  • Nunca commite chaves no código fonte
  • Não inclua em arquivos de configuração versionados
  • Evite logs que possam conter as chaves
  • Não compartilhe via chat ou email

​
Exemplo de Configuração Segura

# .env
VEXY_BANK_API_KEY=pk_test_abc123def456ghi789
VEXY_BANK_API_SECRET=sk_test_xyz789uvw012mno345
VEXY_BANK_BASE_URL=https://api.vexybank.com

// config.js
const config = {
  apiKey: process.env.VEXY_BANK_API_KEY,
  apiSecret: process.env.VEXY_BANK_API_SECRET,
  baseUrl: process.env.VEXY_BANK_BASE_URL
}

export default config

​
Gerenciamento de chaves

​
Rotação de Chaves

Para manter a segurança, recomendamos rotacionar suas chaves:
  1. Gere novas chaves no dashboard
  2. Teste com as novas credenciais
  3. Atualize sua aplicação
  4. Revogue as chaves antigas

​
Múltiplas Chaves

Você pode ter múltiplas chaves API para diferentes propósitos:
  • Desenvolvimento
  • Staging
  • Produção
  • Diferentes aplicações

​
Monitoramento

No dashboard você pode monitorar:
  • Uso das chaves - requisições por chave
  • Rate limits - limites de uso
  • Logs de acesso - histórico de uso
  • Alertas - notificações de uso anormal

​
Em caso de comprometimento

Se suspeitar que suas credenciais foram comprometidas:
  1. Revogue imediatamente as chaves no dashboard
  2. Gere novas credenciais
  3. Entre em contato com nosso suporte
  4. Monitore atividades suspeitas

Emergência

Para incidentes de segurança críticos

Suporte

Para dúvidas gerais sobre API

​
Próximos passos

Gerar token

Aprenda a gerar tokens Bearer para usar na API

PIX IN

Comece a receber pagamentos PIX