Das Nobregas MySQL Panel bietet einen API-Key für programmatischen Zugriff auf Ihr Konto. Mit einem API-Key können Sie Panel-Operationen in Skripte, CI/CD-Pipelines und benutzerdefinierte Anwendungen integrieren, ohne sich über den Browser anzumelden.
Was Ist ein API-Key?
Ein API-Key ist ein einzigartiges geheimes Token, das mit Ihrem Konto verknüpft ist. Er funktioniert wie ein Passwort für automatisierte Systeme — anstatt Ihre E-Mail und Ihr Passwort einzugeben, sendet Ihr Skript den API-Key mit jeder Anfrage zur Authentifizierung.
Ihren API-Key Generieren
- Melden Sie sich unter mysql.nobregas.org an.
- Klicken Sie auf Ihren Avatar (Benutzersymbol) in der oberen rechten Ecke und wählen Sie Profile.
- Scrollen Sie zum Abschnitt API Key.
- Klicken Sie auf den Regenerieren-Button (Sync-Symbol) neben dem API-Key-Feld.
- Ein Bestätigungsdialog erscheint mit der Warnung, dass der aktuelle Key ungültig wird.
- Klicken Sie auf Generate zum Bestätigen.
- Ihr neuer API-Key wird angezeigt. Kopieren Sie ihn sofort — aus Sicherheitsgründen wird er möglicherweise nicht erneut vollständig angezeigt.
Wenn Sie bereits einen API-Key haben und einen neuen generieren, wird der vorherige Key widerrufen und funktioniert nicht mehr. Es existiert immer nur ein aktiver Key gleichzeitig.
Ihren API-Key Verwenden
Fügen Sie den API-Key in Ihre HTTP-Anfragen ein, um sich bei den API-Endpunkten des Panels zu authentifizieren.
Beispiel: cURL
curl -H "Authorization: Bearer IHR_API_KEY" \
https://mysql.nobregas.org/api/databases
Beispiel: PHP
$ch = curl_init('https://mysql.nobregas.org/api/databases');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer IHR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
Beispiel: Python
import requests
headers = {'Authorization': 'Bearer IHR_API_KEY'}
response = requests.get('https://mysql.nobregas.org/api/databases', headers=headers)
Beispiel: Node.js
const response = await fetch('https://mysql.nobregas.org/api/databases', {
headers: { 'Authorization': 'Bearer IHR_API_KEY' }
});
Was Sie mit der API Machen Können
Der API-Key gewährt dieselben Berechtigungen wie Ihre eingeloggte Sitzung:
- Datenbanken und deren Details auflisten.
- Datenbanken erstellen und löschen.
- Datenbankbenutzer und Berechtigungen verwalten.
- Abfragen ausführen.
- Backups erstellen und verwalten.
- IP-Whitelists verwalten.
Sicherheits-Best-Practices
Sicher Aufbewahren
- API-Keys niemals in Git committen oder in ein Versionskontrollsystem.
- Verwenden Sie Umgebungsvariablen, um den Key zu speichern:
export NOBREGAS_API_KEY="ihr_key_hier" - Verwenden Sie einen Secrets Manager in der Produktion (AWS Secrets Manager, Vault, etc.).
Regelmäßig Rotieren
Generieren Sie periodisch einen neuen API-Key. Dies widerruft den alten Key und stellt einen neuen aus, was das Zeitfenster begrenzt, falls ein Key jemals offengelegt wurde.
Exposition Begrenzen
- Teilen Sie den API-Key nur mit Systemen, die ihn benötigen.
- Fügen Sie ihn niemals in clientseitigen Code ein (Browser-JavaScript).
- Senden Sie ihn niemals über unverschlüsselte Kanäle (verwenden Sie immer HTTPS).
Bei Kompromittierung Widerrufen
Wenn Sie vermuten, dass Ihr API-Key geleakt wurde, generieren Sie sofort einen neuen. Der alte Key wird sofort widerrufen.
Ihren API-Key Regenerieren
Um einen neuen Key zu erhalten (und den aktuellen zu widerrufen):
- Gehen Sie zu Profile (über Ihren Avatar in der oberen rechten Ecke) und scrollen Sie zum Abschnitt API Key.
- Klicken Sie auf den Regenerieren-Button (Sync-Symbol) und bestätigen Sie.
- Der alte Key wird widerrufen und ein neuer ausgestellt.
- Aktualisieren Sie alle Skripte und Anwendungen mit dem neuen Key.
