Zmienna środowiskowa XAI_API_KEY
Na tej stronie
Bezpieczne przechowywanie klucza
Klucz API nigdy nie powinien pojawiać się jako zwykły tekst w kodzie źródłowym. Standardowym podejściem jest przechowywanie go w zmiennej środowiskowej, którą aplikacja odczytuje podczas uruchamiania. Oddziela to konfigurację od kodu i chroni Twoje dane poufne.
Ustawienie XAI_API_KEY
Konwencją stosowaną przez xAI oraz wszystkie oficjalne zestawy SDK (SDK) jest zmienna XAI_API_KEY. Oto jak ją skonfigurować w Twoim systemie.
Linux i macOS
W terminalu dodaj zmienną do profilu swojej powłoki:
echo 'export XAI_API_KEY="xai-your-key-here"' >> ~/.bashrc
source ~/.bashrc
W przypadku Zsh (domyślnego w macOS) zamień .bashrc na .zshrc.
Windows (PowerShell)
$env:XAI_API_KEY = "xai-your-key-here"
Aby ustawienie było trwałe, skorzystaj z zmiennych środowiskowych systemu w ustawieniach zaawansowanych lub uruchom:
[System.Environment]::SetEnvironmentVariable("XAI_API_KEY", "xai-your-key-here", "User")
Plik .env (projekty lokalne)
W projektach wykorzystujących frameworki (Node.js, Django, Flask) utwórz plik .env w katalogu głównym:
XAI_API_KEY=xai-your-key-here
Musisz dodać .env do pliku .gitignore, aby nie wysłać swoich danych poufnych do repozytorium Git:
# .gitignore
.env
.env.local
.env.*.local
Sprawdzenie konfiguracji
Przetestuj, czy zmienna jest dostępna:
echo $XAI_API_KEY
Powinieneś zobaczyć swój klucz. Jeśli polecenie zwróci pusty wiersz, przeładuj profil powłoki lub uruchom terminal ponownie.
W Pythonie możesz to sprawdzić w następujący sposób:
import os
key = os.getenv("XAI_API_KEY")
print("Key configured" if key else "Variable missing")
Środowiska produkcyjne
W środowisku produkcyjnym nie używaj pliku .env. Zamiast tego skorzystaj z wbudowanych mechanizmów swojej platformy:
- Docker:
docker run -e XAI_API_KEY=xai-xxx my-image - Kubernetes: Secret zamontowany jako zmienna środowiskowa
- Vercel / Netlify / Railway: zmienne w panelu projektu
- GitHub Actions: sekrety repozytorium (
${{ secrets.XAI_API_KEY }})
Systemy te szyfrują sekrety w stanie spoczynku i wstrzykują je wyłącznie podczas działania aplikacji.
Częste błędy
- Dodatkowe cudzysłowy w kluczu: jeśli zmienna zawiera dosłowne cudzysłowy, żądania zakończą się błędem uwierzytelniania
- Zmienna ustawiona w innej powłoce: zmienne z jednego terminala nie są dostępne w innym, chyba że zostały wyeksportowane w profilu
- Spacje wokół znaku
=: w pliku.envskładniaXAI_API_KEY = wartośćze spacjami może nie działać, w zależności od używanej biblioteki
Kluczowe wnioski
- Używaj zmiennej
XAI_API_KEY, rozpoznawanej przez każde SDK xAI - Nigdy nie umieszczaj klucza na sztywno w kodzie źródłowym
- Dodaj
.envdo pliku.gitignorewe wszystkich swoich projektach - W środowisku produkcyjnym korzystaj z wbudowanych mechanizmów zarządzania sekretami swojej platformy hostingowej