Chaves de API
Crie chaves de API para integrar sistemas externos, criar painéis personalizados ou automatizar fluxos de trabalho com dados do Balla Stats.
Pré-requisitos
Antes de criar chaves de API, você precisa:
- Uma conta Balla Stats
- Plano PRO ou superior
Limites do plano: FREE = 0 chaves, PRO = 3 chaves (1.000 req/h), TEAM = 10 chaves (10.000 req/h), ENTERPRISE = 50 chaves (100.000 req/h).
Crie chaves de API para integrar sistemas externos, criar painéis personalizados ou automatizar fluxos de trabalho com dados do Balla Stats.
Permissões com escopo
Controle de acesso granular
Limitação de taxa
Limites de solicitação por chave
Acompanhamento de uso
Pista de auditoria completa
- Navegue até Chaves de API
- Crie sua primeira chave
- Copie e salve com segurança
- Use sua chave API
- Monitorar o uso
- Girar ou revogar chaves
Na barra lateral do painel, clique em API Keys. Esta página mostra todas as suas chaves existentes e permite criar novas.
Clique em "Criar chave de API", insira um nome descritivo e selecione os escopos de que sua chave precisa. Os escopos disponíveis incluem: read, write, matches, players, teams, seasons, and stats.
Comece com o escopo somente leitura e adicione permissões de gravação somente quando necessário. Isso segue o princípio do menor privilégio.
Sua chave será exibida no formato balla_sk_[64 caracteres hexadecimais]. Esta é a única vez que você verá a chave completa. Copie-o imediatamente e guarde-o em um local seguro.
Sua chave API será mostrada apenas uma vez. Copie-a agora e armazene-a com segurança. Não pode ser recuperado posteriormente. Se você perdê-la, precisará girá-la ou criar uma nova chave.
Inclua sua chave de API no cabeçalho Authorization de suas solicitações HTTP:
curl -H "Authorization: Bearer balla_sk_..." \
https://api.ballastats.com/api/matchesOu em JavaScript:
const response = await fetch(
'https://api.ballastats.com/api/matches',
{
headers: {
'Authorization': 'Bearer balla_sk_...',
'Content-Type': 'application/json',
},
}
);
const data = await response.json();Todos os endpoints estão documentados em /api-docs. Consulte o tutorial API Documentation para obter detalhes.
Veja o carimbo de data/hora usado pela última vez, a contagem total de solicitações e o status do limite de taxa atual da sua chave. As estatísticas de uso ajudam você a entender o desempenho de suas integrações e quando pode ser necessário atualizar seu plano.
Rotate uma chave para criar uma nova, preservando seu nome, escopos e configurações. A chave antiga é imediatamente revogada. Revoke desativa permanentemente uma chave. As chaves revogadas não podem ser reativadas.
A rotação de uma chave invalida imediatamente a chave antiga. Atualize suas integrações com a nova chave antes de fazer a rotação para evitar tempo de inatividade.
Use nomes descritivos
Use nomes descritivos como “Dashboard Bot” ou “Stats Exporter” para que você possa identificar facilmente a finalidade de cada chave.
Menor privilégio
Siga o princípio do menor privilégio – conceda apenas os escopos que sua integração realmente precisa.
Rotação regular
Gire as chaves regularmente (a cada 90 dias) para segurança. Defina um lembrete para ficar atento às principais práticas de higiene.
Nunca exponha chaves
Nunca confirme chaves de API no código-fonte ou compartilhe-as em texto simples. Use variáveis de ambiente ou gerenciadores secretos.
401 Não autorizado
- Sua chave pode estar inativa, revogada ou expirada
- Verifique se a chave está incluída no cabeçalho Authorization
- Certifique-se de que o formato do cabeçalho seja
Bearer balla_sk_...
403 Proibido
- Sua chave não tem o escopo necessário para este endpoint
- Edite a chave para adicionar o escopo necessário (por exemplo, adicione
writepara solicitações POST) - Verifique na documentação da API quais escopos cada endpoint requer
429 Muitas solicitações
- Você excedeu seu limite de taxa para a hora atual
- Aguarde a redefinição da janela de limite de taxa ou atualize seu plano para limites mais altos
- Verifique o cabeçalho
Retry-Afterpara saber quando você pode tentar novamente