Autentimine, API-võtmed ja organisatsioon
Sellel lehel
Autentimine, API-võtmed ja organisatsioon
Enne kui kirjutad esimesegi koodirea, pead konfigureerima oma API-juurdepääsu. Selles õppetükis käsitletakse võtmete loomist, juurdepääsu struktureerimist organisatsioonide ja projektide kaudu ning turvameetmeid, mis hoiavad ära klassikalise õudusunenäo: võtme kogemata avalikku hoidlasse laadimise, kus võõras inimene seda üleöö tarbima hakkab.
Loo konto ja hanki võti
Protsess koosneb kolmest sammust. Kõigepealt mine aadressile platform.openai.com ja loo konto; saad automaatselt tasuta krediiti katsetamiseks. Seejärel liigu armatuurlaual jaotisse API Keys ja genereeri uus võti. Sa näed seda võtit ainult üks kord: kopeeri see kohe, kuid ära kleebi seda oma koodi.
# Sinu API-võti näeb välja selline (ära jaga seda kunagi!)
# sk-proj-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# Parim tava: kasuta keskkonnamuutujat
import os
api_key = os.environ.get("OPENAI_API_KEY")
Kolmas samm on keskkonnamuutuja deklareerimine, mis sõltub sinu platvormist. Arendusmasinas on sageli kõige mugavam kasutada faili .env, mida laadib python-dotenv. Serveris eelista oma orkestraatori või saladusteenuse poolt määratletud keskkonnamuutujat.
# Linux / macOS — lisa faili ~/.bashrc või ~/.zshrc
export OPENAI_API_KEY="sk-proj-your-key-here"
# Windows PowerShell
$env:OPENAI_API_KEY = "sk-proj-your-key-here"
# Fail .env (koos python-dotenv-iga)
# .env
OPENAI_API_KEY=sk-proj-your-key-here
Millist võtmetüüpi valida
Projektivõtmed, mida saab tuvastada eesliite sk-proj- järgi, on seotud konkreetse projektiga ja pakuvad parimat kontrolli. Kasutad neid peaaegu alati. SDK tuvastab need automaatselt, kui keskkonnamuutuja on seatud, mistõttu OpenAI() initsialiseeritakse kõigis selle kursuse näidetes ilma argumentideta.
from openai import OpenAI
# SDK tuvastab automaatselt OPENAI_API_KEY
client = OpenAI()
# Või määra eksplitsiitselt (tootmises mitte soovitatav)
client = OpenAI(api_key="sk-proj-...")
Teine tüüp on teenusevõtmed. Need on mõeldud serverirakendustele, mis vajavad kõrgendatud juurdepääsu; need annavad täiendavaid õigusi ja nõuavad seetõttu erilist hoolt: hoia neid saladuste hoidlas ja ära kunagi edasta nende väärtust arendustööjaama.
Organisatsioonid ja projektid
Juurdepääs on struktureeritud kolmel pesastatud tasandil:
- Organisatsioon: Sinu ettevõte või meeskond
- Projekt: Loogiline rühmitus (nt „Tootmise vestlusrobot“, „Andmeanalüüs“)
- API-võti: Seotud konkreetse projektiga
Kui kuulud mitmesse organisatsiooni, määra klienti initsialiseerides see, mida kasutada soovid:
from openai import OpenAI
# Määra organisatsioon (kasulik, kui kuulud mitmesse)
client = OpenAI(
organization="org-xxxxxxxxxxxx",
project="proj-xxxxxxxxxxxx"
)
Võta aega, et jagada oma kasutus projektide vahel, selle asemel et suunata kõik läbi ühe võtme. Näed selle kasu esimeste probleemide ilmnemisel. Igal projektil on oma kasutuse jälgimine, mis võimaldab omistada kulud konkreetsele funktsioonile, mitte hägusele kuuüldsummale. Ka kiirusepiirangud on eraldatud: öine partiiülesanne, mis küllastab oma kvoodi, ei takista sinu vestlusrobotit klientidele vastamast. Saad seejärel määrata igale projektile erinevad liikmed ja mis kõige tähtsam – tühistada kompromiteeritud võtme, katkestamata teiste rakenduste tööd.
Ära kunagi avalda oma võtmeid
Reegel on lihtne ja absoluutne: võti ei tohi kunagi ilmuda lähtekoodi. Allpool olevate kahe koodilõigu kontrast räägib rohkem kui pikk loeng.
# HALB — kõvakodeeritud võti koodis
client = OpenAI(api_key="sk-proj-abc123") # OHT!
# HEA — keskkonnamuutuja
client = OpenAI() # Loeb automaatselt OPENAI_API_KEY
# HEA — fail .env koos python-dotenv-iga
from dotenv import load_dotenv
load_dotenv()
client = OpenAI()
Järeldus puudutab faili .gitignore, mis peab välistama kohalikud konfiguratsioonifailid enne esimest kommiiti, mitte pärast. Avaldatud ja seejärel kustutatud võti jääb hoidla ajalukku alles.
# LISA NEED READ ALATI oma faili .gitignore
.env
.env.local
.env.production
*.key
Lõpuks planeeri regulaarne pööramine iga 90 päeva tagant. Saad seda teha ilma seisakuta: loo uus võti, uuenda oma kasutuselevõtte ja kustuta vana võti alles siis, kui seda enam miski ei kasuta.
Kontrolli oma konfiguratsiooni
Enne edasiliikumist käivita see skript. See kontrollib võtme olemasolu, kuvab selle lühendatud versiooni kinnitamaks, et tegemist on õige võtmega, ja teeb seejärel tegeliku päringu. Käivita see test uuesti iga kord, kui keskkond käitub imelikult.
from openai import OpenAI
import os
def verify_configuration():
"""Kontrolli, kas API konfiguratsioon on korrektne."""
# Kontrolli võtme olemasolu
api_key = os.environ.get("OPENAI_API_KEY")
if not api_key:
print("VIGA: OPENAI_API_KEY on määramata")
return False
print(f"Võti tuvastatud: {api_key[:8]}...{api_key[-4:]}")
# Testi ühendust
try:
client = OpenAI()
response = client.responses.create(
model="gpt-5.6-terra",
input="Reply only: OK"
)
print(f"Ühendus õnnestus: {response.output_text}")
return True
except Exception as e:
print(f"Ühenduse VIGA: {e}")
return False
verify_configuration()
# Oodatav tulemus:
# Võti tuvastatud: sk-proj-...xxxx
# Ühendus õnnestus: OK
Peamised punktid
- Kasuta iga rakenduse jaoks projektivõtmeid (
sk-proj-...) - Hoia oma võtmeid keskkonnamuutujates, mitte kunagi koodis
- Korralda oma juurdepääs hierarhia Organisatsioon → Projekt → Võti abil
- Teosta võtmete regulaarne pööramine (iga 90 päeva tagant)
- Lisa
.envalati oma faili.gitignore