API raktai

Autorius: Aether365 komanda Auditorija: Kūrėjai Apimtis: API raktų valdymo galutiniai taškai

API raktai naudojami REST API užklausų autentifikavimui be vartotojo sesijos.

Kiekvienas API raktas susietas su organizacijos paskyra, kuri jį sukūrė. API raktai turi tokią pačią prieigą kaip komandos narys - jie gali skaityti ir rašyti visus organizacijos duomenis, bet negali keisti atsiskaitymo ar plano nustatymų.

API raktų sąrašas

Grąžina visus aktyvius organizacijos API raktus.

GET /tenants/me/api-keys

INFO

Saugumo sumetimais pilna rakto reikšmė grąžinama tik vieną kartą - kūrimo metu. Vėlesni sąrašo užklausos rodo tik rakto priešdėlį ir metaduomenis.

Užklausos pavyzdys

curl https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>"

Atsakymo pavyzdys

{
  "success": true,
  "data": [
    {
      "id": "key_abc123",
      "name": "CI pipeline",
      "prefix": "ae_live_abc1",
      "createdAt": "2026-03-01T09:00:00Z",
      "lastUsedAt": "2026-04-10T14:23:00Z"
    }
  ]
}

Atsakymo laukai

Laukas	Tipas	Aprašymas
id	string	Rakto identifikatorius
name	string	Rodomas pavadinimas
prefix	string	Pirmieji 12 rakto simbolių (identifikavimui)
createdAt	string	ISO 8601 laiko žymė
lastUsedAt	string arba null	ISO 8601 paskutinės autentifikuotos užklausos laiko žymė

---

API rakto kūrimas

Sukuria naują API raktą. Pilna rakto reikšmė grąžinama vieną kartą ir negali būti gauta vėliau.

POST /tenants/me/api-keys

Užklausos turinys

{
  "name": "CI pipeline"
}

Laukas	Tipas	Būtinas	Aprašymas
name	string	Taip	Rodomas rakto pavadinimas

Užklausos pavyzdys

curl -X POST https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI pipeline"}'

Atsakymo pavyzdys

{
  "success": true,
  "data": {
    "id": "key_abc123",
    "name": "CI pipeline",
    "key": "ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "prefix": "ae_live_abc1",
    "createdAt": "2026-04-12T10:00:00Z",
    "lastUsedAt": null
  }
}

Iš karto išsaugokite raktą

key laukas grąžinamas tik šiame atsakyme. Jo negalima gauti vėliau. Iš karto išsaugokite jį slaptųjų raktų tvarkyklėje (GitHub Actions secrets, HashiCorp Vault ir kt.).

---

API rakto trynimas

Visam laikui atšaukia API raktą. Visos užklausos su šiuo raktu iš karto grąžins 401.

DELETE /tenants/me/api-keys/{keyId}

Užklausos pavyzdys

curl -X DELETE https://api.aether365.io/tenants/me/api-keys/key_abc123 \
  -H "Authorization: Bearer <token>"

Atsakymo pavyzdys

{
  "success": true,
  "data": null
}

---

API rakto naudojimas

Perduokite API raktą kaip Bearer tokeną Authorization antraštėje:

curl https://api.aether365.io/tenants/me/scans \
  -H "Authorization: Bearer ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

API raktai veikia taip pat kaip sesijų tokenai visiems galutiniams taškams. Jie neturi galiojimo pabaigos, bet galite juos rotuoti sukurdami naują raktą ir ištrindami senąjį.

Užklausų limitai

API apribotas iki 120 užklausų per minutę vienam API raktui. Užklausos, viršijančios limitą, gauna 429 Too Many Requests atsakymą. Atsakyme yra Retry-After antraštė, nurodanti, kada galite kartoti.