O Painel Nobregas MySQL disponibiliza uma chave API para acesso programático à sua conta. Com uma chave API, pode integrar operações do painel em scripts, pipelines CI/CD e aplicações personalizadas sem iniciar sessão pelo navegador.
O Que É uma Chave API?
Uma chave API é um token secreto único associado à sua conta. Funciona como uma palavra-passe para sistemas automatizados — em vez de introduzir o seu email e palavra-passe, o seu script envia a chave API com cada pedido para se autenticar.
Gerar a Sua Chave API
- Inicie sessão em mysql.nobregas.org.
- Clique no seu avatar (ícone de utilizador) no canto superior direito e selecione Profile.
- Desloque-se até à secção API Key.
- Clique no botão de regenerar (ícone de sincronização) ao lado do campo da chave API.
- Aparece um diálogo de confirmação a avisar que a chave atual será invalidada.
- Clique em Generate para confirmar.
- A sua nova chave API é apresentada. Copie-a imediatamente — por razões de segurança, pode não ser mostrada novamente na totalidade.
Se já tem uma chave API e gera uma nova, a chave anterior é revogada e deixa de funcionar. Apenas uma chave ativa existe de cada vez.
Utilizar a Sua Chave API
Inclua a chave API nos seus pedidos HTTP para se autenticar com os endpoints API do painel.
Exemplo: cURL
curl -H "Authorization: Bearer SUA_CHAVE_API" \
https://mysql.nobregas.org/api/databases
Exemplo: PHP
$ch = curl_init('https://mysql.nobregas.org/api/databases');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer SUA_CHAVE_API'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
Exemplo: Python
import requests
headers = {'Authorization': 'Bearer SUA_CHAVE_API'}
response = requests.get('https://mysql.nobregas.org/api/databases', headers=headers)
Exemplo: Node.js
const response = await fetch('https://mysql.nobregas.org/api/databases', {
headers: { 'Authorization': 'Bearer SUA_CHAVE_API' }
});
O Que Pode Fazer com a API
A chave API concede as mesmas permissões que a sua sessão com login:
- Listar bases de dados e os seus detalhes.
- Criar e eliminar bases de dados.
- Gerir utilizadores de base de dados e privilégios.
- Executar consultas.
- Criar e gerir backups.
- Gerir whitelists de IP.
Boas Práticas de Segurança
Armazenar com Segurança
- Nunca submeta chaves API para Git ou qualquer sistema de controlo de versões.
- Use variáveis de ambiente para armazenar a chave:
export NOBREGAS_API_KEY="sua_chave_aqui" - Use um gestor de segredos em produção (AWS Secrets Manager, Vault, etc.).
Rodar Regularmente
Gere uma nova chave API periodicamente. Isto revoga a chave antiga e emite uma nova, limitando a janela caso uma chave tenha sido exposta.
Limitar Exposição
- Apenas partilhe a chave API com sistemas que precisem dela.
- Nunca a inclua em código do lado do cliente (JavaScript no navegador).
- Nunca a envie por canais não encriptados (use sempre HTTPS).
Revogar Se Comprometida
Se suspeitar que a sua chave API foi divulgada, gere imediatamente uma nova. A chave antiga é revogada instantaneamente.
Regenerar a Sua Chave API
Para obter uma nova chave (e revogar a atual):
- Vá a Profile (através do seu avatar no canto superior direito) e desloque-se até à secção API Key.
- Clique no botão de regenerar (ícone de sincronização) e confirme.
- A chave antiga é revogada e uma nova é emitida.
- Atualize todos os scripts e aplicações com a nova chave.
