Pāriet uz galveno saturu
Latviešu— Izvēlēties valodu
Izvēlne

API atslēgas izveide un konfigurēšana

Nodarbība 2 no 14 Atjaunota 2026. gada 29. jūlijs Programmētājs
Šajā lapā
  1. Kāpēc veidot atslēgas, izmantojot API
  2. Izveides galapunkts
  3. Pilns piemērs ar curl
  4. Ieteicamās ACL stratēģijas
  5. Pieejamie ACL galapunkti
  6. Galvenās atziņas

Kāpēc veidot atslēgas, izmantojot API

Atslēgas manuāla izveide aizņem trīsdesmit sekundes — tieši tāpēc tev ir nepieciešama automatizācija. Tā kā process ir ātrs, tu to veic bez pārdomām: nav nosaukumu konvenciju, nav ātruma ierobežojumu, tikai vispārīga “lai darbotos ātri”. Sešus mēnešus vēlāk neviens nezina, ko kura atslēga dara.

API izmantošana piespiež tevi katru atslēgu nosaukt, noteikt tās darbības jomu un ierobežojumus, jo tie ir skripta parametri. Konsekvence vairs nav disciplīna, kas jāuztur manuāli, bet gan kļūst par koda īpašību. Tu vari automatizēt atslēgu izveidi saviem vidēm (izstrāde, testēšana, produkcija), piemērot granulu piekļuves kontroles sarakstus (ACL) un definēt ātruma ierobežojumus — visu to tieši savos izvietošanas skriptos vai infrastruktūras rīkos.

Izveides galapunkts

Lai izveidotu API atslēgu, nosūti POST pieprasījumu uz šo galapunktu:

POST /auth/teams/{teamId}/api-keys

Pieprasījuma ķermenis

{
  "name": "ma-cle-production",
  "acls": [
    "api-key:endpoint:chat",
    "api-key:model:grok-4.20-0309-reasoning"
  ],
  "qps": 10,
  "qpm": 100,
  "tpm": 1000000,
  "expireTime": "2026-12-31T23:59:59Z"
}

Detalizēti parametri

name (obligāts): lasāms identifikators tavai atslēgai. Izvēlies aprakstošu nosaukumu, kas norāda uz lietojumu (prod-backend, staging-chatbot, dev-john). Šis nosaukums parādās konsolē un lietojuma žurnālos.

acls (obligāts): šai atslēgai piešķirto atļauju saraksts. Pieejami divi formāti:

  • api-key:endpoint:[endpoint] — ierobežo pieejamos galapunktus (chat, embed, image, models, sample, tokenize, documents)
  • api-key:model:[model] — ierobežo izmantojamos modeļus (grok-4.20-0309-reasoning, grok-4.3 u.c.)

Raksturs * darbojas kā aizstājējzīme: api-key:endpoint:* atļauj visus galapunktus, api-key:model:* — visus modeļus. Paturē to tikai lokālai izstrādei. Produkcijas vidē aizstājējzīme nozīmē, ka kompromitēta atslēga dod piekļuvi visam, ko tava komanda var darīt — tostarp dārgākajiem modeļiem, kurus tava lietotne varētu nekad neizmantot.

qps (neobligāts): pieprasījumi sekundē — maksimālais pieprasījumu skaits sekundē.

qpm (neobligāts): pieprasījumi minūtē — maksimālais pieprasījumu skaits minūtē.

tpm (neobligāts): tokeni minūtē — maksimālais apstrādāto tokenu skaits minūtē.

expireTime (neobligāts): derīguma termiņa beigu datums ISO 8601 formātā. Atslēga šajā datumā tiks automātiski deaktivizēta.

Pilns piemērs ar curl

curl -X POST "https://management-api.x.ai/auth/teams/$TEAM_ID/api-keys" \
  -H "Authorization: Bearer $MANAGEMENT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "prod-backend-v2",
    "acls": [
      "api-key:endpoint:chat",
      "api-key:endpoint:embed",
      "api-key:model:grok-4.20-0309-reasoning",
      "api-key:model:grok-4.3"
    ],
    "qps": 20,
    "qpm": 500,
    "tpm": 2000000,
    "expireTime": "2027-06-30T23:59:59Z"
  }'

Atbilde satur slepeno atslēgu, kas nekad vairs netiks parādīta. Šim noteikumam ir praktiskas sekas, kas tev jāparedz pirms skripta palaišanas, nevis pēc tā: ja veido atslēgas ciklā, glabāšanai jānotiek tajā pašā darbībā. Atslēga, kas pazūd starp izveidi un reģistrāciju, nav atgūstama — tev tā ir jādzēš un jāsāk no jauna. Ieraksti to drošā krātuvē (Vault, AWS Secrets Manager), nevis terminaļa standarta izvades plūsmā, kur tā nonāks tavā komandu vēsturē.

Ieteicamās ACL stratēģijas

Izstrādes atslēga (plaša)

{
  "acls": ["api-key:endpoint:*", "api-key:model:*"],
  "qps": 5,
  "qpm": 50
}

Ideāli piemērota lokālai izstrādei: piekļuve ir plaša, jo iepriekš nezini, ko tieši mēģināsi, taču ātruma ierobežojumi paliek zemi. Tas ir pareizais kompromiss — bezgalīgs cikls, ko kļūdas dēļ uzraksti piektdienas vakarā, izmaksās dažus centus, nevis simtiem eiro.

Produkcijas atslēga (ierobežota)

{
  "acls": [
    "api-key:endpoint:chat",
    "api-key:model:grok-4.20-0309-reasoning"
  ],
  "qps": 50,
  "qpm": 2000,
  "tpm": 5000000
}

Produkcijas vidē noteikums ir pretējs: sāc no tā, ko lietotne faktiski dara, un atļauj tikai to. Jautājums, kas tev jāuzdod, rakstot ACL, vienmēr ir viens un tas pats — ja šī atslēga rīt noplūdīs, ko trešā persona varēs ar to izdarīt? Atslēga, kas ierobežota tikai līdz čatam vienā modelī un ierobežota līdz desmit pieprasījumiem sekundē, sniedz īsu atbildi.

Pagaidu atslēga (ar derīguma termiņu)

{
  "acls": ["api-key:endpoint:*", "api-key:model:*"],
  "expireTime": "2026-04-10T00:00:00Z"
}

Automātiska termiņa beigšanās atrisina problēmu, ko neviens nerisina: atslēgas, kuras cilvēki aizmirst dzēst. POC, demonstrācija, īslaicīgs darbuzņēmējs — visos šajos gadījumos expireTime garantē, ka piekļuve izslēgsies pati. Tas ir vienīgais uzticamais veids, kā uzturēt tīru inventāru, jo tas nav atkarīgs no neviena cilvēka atmiņas.

Pieejamie ACL galapunkti

Lai redzētu galapunktus, kurus vari izmantot ACL, konsultējies ar:

GET /auth/teams/{teamId}/endpoints

Pieejamie galapunkti ir: chat, embed, image, models, sample, tokenize, documents. Šis saraksts laika gaitā var mainīties, tāpēc pārbaudi to regulāri.

Galvenās atziņas

  • Atslēgu izveide notiek, izmantojot POST /auth/teams/{teamId}/api-keys
  • ACL seko formātam api-key:endpoint:[nosaukums] vai api-key:model:[nosaukums]
  • Aizstājējzīme * piešķir pilnu piekļuvi visiem galapunktiem vai modeļiem
  • Slepenā atslēga tiek parādīta tikai vienreiz izveides brīdī — saglabā to uzreiz
  • Vienmēr definē lietojumam atbilstošus ātruma ierobežojumus (qps, qpm, tpm)
  • Pagaidu atslēgām izmanto expireTime