Pular para o conteúdo principal

Chaves de API

Todos os endpoints v1 exigem uma chave de API no cabeçalho x-api-key.

Criar chaves de API

  1. Acesse o dashboard da AFKCrypto
  2. Vá para a seção API Keys
  3. Clique em “Generate API Key”
  4. Dê um nome descritivo à chave
  5. Opcional: defina uma expiração (7 dias, 30 dias, 90 dias, 180 dias ou 1 ano)
  6. Copie a chave imediatamente — ela não será mostrada novamente

Formato da chave

afk_<prefix>_<random>

Exemplo: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56
  • Prefix: identificador de 4 caracteres para busca rápida
  • Random: string aleatória de 32 caracteres, criptograficamente segura

Uso de chaves de API

Inclua a chave em todas as solicitações no cabeçalho x-api-key:
curl -X GET https://api.afkcrypto.com/api/v1/wallets \
  -H "x-api-key: afk_xY3z_Ab12cD34Ef56Gh78Ij90Kl12Mn34Op56"

Boas práticas de segurança

  • Nunca versione chaves de API — use variáveis de ambiente
  • Rotacione chaves regularmente — defina expiração para acessos temporários
  • Use chaves separadas por ambiente — dev, staging, produção
  • Revogue chaves não utilizadas imediatamente — reduza a superfície de ataque
  • Armazene com segurança — use um gerenciador de segredos (ex.: AWS Secrets Manager, HashiCorp Vault)

Expiração da chave

Chaves de API podem expirar após um período definido:
  • Nunca expira (padrão): válida até ser revogada
  • 7 dias: testes/demonstrações de curto prazo
  • 30 dias: acesso para contratados ou testes
  • 90 dias: rotação trimestral recomendada
  • 180 dias: rotação semestral
  • 1 ano: rotação anual para integrações estáveis
O que acontece quando a chave expira?
  • Solicitações com essa chave retornam HTTP 401 UNAUTHORIZED
  • A chave permanece visível no dashboard para auditoria
  • Crie uma nova chave para substituí-la
Monitoramento de expiração
  • O dashboard marca “Expired” ou “Expiring soon” (≤ 7 dias)
  • Configure alertas para evitar interrupções

Limites de chaves

  • Máximo de chaves ativas: 10 por usuário
  • Aplica-se limitação de taxa: consulte Rate limiting
  • Revogue chaves não usadas para manter-se dentro do limite

Revogar chaves de API

Revogue uma chave imediatamente pelo dashboard:
  1. Abra API Keys
  2. Encontre a chave a revogar
  3. Clique em “Revoke Key”
  4. Confirme a ação
Observação: a revogação é permanente e tem efeito imediato.

Relacionados