Autentimine Bearer-tokeniga
Sellel lehel
Turva oma API-päringuid
Iga xAI API-le saadetud päring peab olema autentitud. API kasutab Bearer-tokeni skeemi, mis on REST API-de jaoks laialdaselt levinud standard. Selles õppetükis selgitame, kuidas see mehhanism toimib, ja jagame parimaid tavasid võtmete kaitsmiseks tootmiskeskkonnas.
Bearer-tokeni skeem
Nagu nimigi ütleb, pääseb API-le juurde igaüks, kes tokenit omab (“kannab”). Seetõttu on võtme kaitsmine fundamentaalne: tokenist enda kõrval muid identiteedikontrolle ei toimu.
Päise vorming
Iga HTTP-päring peab sisaldama päist Authorization, millele järgneb eesliide Bearer ja sinu võti:
Authorization: Bearer xai-your-api-key
cURL-i kasutades näeb see välja nii:
curl https://api.x.ai/v1/responses \
-H "Authorization: Bearer $XAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "grok-4.5", "input": "Hello"}'
Pythonis haldavad SDK-d seda päist automaatselt, kui annad võtme kliendi konstruktorile edasi.
Autentimisvead
HTTP 401 Unauthorized
See viga tähendab, et sinu võti puudub, on vigane või tühistatud. Kontrolli järgmist:
- Kas keskkonnamuutuja
XAI_API_KEYon määratud - Kas võti algab eesliitega
xai- - Kas võtit pole konsoolis tühistatud
HTTP 403 Forbidden
Sinu võti on kehtiv, kuid sellel pole taotletud toimingu jaoks vajalikke õigusi. See võib juhtuda meeskondlike piirangute tõttu teatud operatsioonidel.
Turvalisuse parimad tavad
Ära avalda võtmeid koodis
Võtmed ei tohi kunagi ilmneda lahtises tekstis:
- Versioneeritud lähtekoodis (Git)
- Rakenduse logides
- URL-ides või päringuparameetrites
- Kasutajatele näidatavates veateadetes
- GitHubi probleemides ja tõmbetaotlustes
Kasuta saladuste hoidlat
Tootmiskeskkonnas hoia oma võtmeid spetsiaalses süsteemis:
- AWS Secrets Manager või Parameter Store
- Google Secret Manager
- Azure Key Vault
- HashiCorp Vault
- Sinu CI/CD platvormi saladused (GitHub Actions, GitLab CI)
Võtmete rotatsioon
Vaheta oma võtmeid regulaarselt ja viivitamatult, kui kahtlustad lekkest:
- Loo xAI konsoolis uus võti
- Uuenda võti oma saladuste hoidlas
- Paiguta rakendus uuesti
- Kontrolli, kas kõik toimib uue võtmega
- Tühista vana võti konsoolis
Piira õigusi
Kui töötad meeskonnas, loo iga teenuse ja keskkonna jaoks eraldi võtmed. Kui üks neist kompromiteeritakse, piirdub mõju vaid ühe kontekstiga.
Lekete tuvastamine
Eesliide xai- võimaldab tuvastustööriistadel (GitHubi saladuste skaneerimine, GitGuardian, TruffleHog) tuvastada võtmeid lähtekoodis automaatselt. Lülita need tööriistad oma hoidlates sisse, et saada viivitamatult teavitatud juhusliku avalikustamise korral.
Kui võti avastatakse avalikus commit’is:
- Tühista see viivitamatult xAI konsoolis
- Kontrolli oma kasutusajalugu petturliku tegevuse osas
- Loo uus võti
- Puhasta oma Giti ajalugu (või veel parem – käsitle võtit kompromiteerituna ja liigu edasi)
HTTPS on kohustuslik
xAI API aktsepteerib ainult HTTPS-ühendusi. TLS krüpteerib sinu päringud edastamise ajal, sealhulgas päise Authorization. Ära kunagi püüa sellest kaitsest mööda hiilida: krüpteerimata HTTP kaudu saadetud päring paljastaks sinu võtme võrgus.
Peamised punktid
- API kasutab päise
Authorizationkaudu Bearer-tokeni skeemi - Võti on ainus autentimistegur: kaitse seda nagu parooli
- Kasuta tootmiskeskkonnas saladuste hoidlat ja ära kunagi kodeeri võtmeid otse koodi
- Lülita lekete tuvastamine sisse oma Giti hoidlates
- Vaheta võtmeid regulaarselt ja tühista kompromiteeritud võti viivitamatult
Kontrolli oma arusaamist
xAI API alused: viimane kontroll enne arendamist.
1. Mida peaksid tegema API-võtmega kohe pärast selle loomist?
Vastus: Salvesta see turvalisse kohta (seda näidatakse ainult üks kord), avalda see muutuja XAI_API_KEY kaudu, mitte ei kodeeri seda otse koodi, kasuta iga keskkonna jaoks eraldi võtit ja testi seda kohe päringuga aadressile /v1/models.
2. Mis on baas-URL ja miks see nii oluline on?
Vastus: https://api.x.ai/v1. See võimaldab OpenAI ühilduvust: piisab base_url ja võtme muutmisest, et suunata olemasolev OpenAI kood Grokile.
3. Milliseid SDK-sid saad Grokiga kasutada?
Vastus: Natiivne xAI SDK, OpenAI SDK (koos xAI base_url-iga) ja JavaScripti poolel Vercel AI SDK, lisaks cURL testimiseks: ökosüsteem on avatud.
4. Mis on peamine genereerimise lõpp-punkt?
Vastus: POST /v1/responses, mis on kaasaegne vorming; chat/completions jääb kättesaadavaks kui pärandvalik ühilduvuse tagamiseks.
5. Kuidas autentitakse iga päringut?
Vastus: Päise Authorization: Bearer ja võtmega xai-…: standardne Bearer-tokeni skeem, sama sõltumata SDK-st või tööriistast.
Turvatud võti, baas-URL, sinu valitud SDK, Bearer kõikjal: alus on paigas ja järgmised API kursused ehitavad sellele edasi.