API atslēgas

API atslēgas tiek izmantotas, lai autentificētu pieprasījumus REST API bez lietotāja sesijas.

Katra API atslēga ir piesaistīta nomniekam, kas to izveidoja. API atslēgām ir tāda pati piekļuve kā komandas dalībniekam - tās var lasīt un rakstīt visus nomnieka datus, bet nevar mainīt norēķinu vai plāna iestatījumus.

API atslēgu saraksts

Atgriež visas aktīvās API atslēgas nomniekam.

GET /tenants/me/api-keys

INFO

Drošības nolūkos pilna atslēgas vērtība tiek atgriezta tikai vienu reizi - izveides brīdī. Turpmākie saraksta pieprasījumi rāda tikai atslēgas prefiksu un metadatus.

Pieprasījuma piemērs

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

Atbildes piemērs

{
  "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"
    }
  ]
}

Atbildes lauki

Lauks	Tips	Apraksts
id	string	Atslēgas identifikators
name	string	Attēlošanas nosaukums
prefix	string	Pirmie 12 atslēgas rakstzīmes (identifikācijai)
createdAt	string	ISO 8601 laikspiedols
lastUsedAt	string vai null	ISO 8601 laikspiedols pēdējam autentificētajam pieprasījumam

---

API atslēgas izveide

Izveido jaunu API atslēgu. Pilna atslēgas vērtība tiek atgriezta vienu reizi un vēlāk nav izgūstama.

POST /tenants/me/api-keys

Pieprasījuma pamatteksts

{
  "name": "CI pipeline"
}

Lauks	Tips	Obligāts	Apraksts
name	string	Jā	Attēlošanas nosaukums atslēgai

Pieprasījuma piemērs

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

Atbildes piemērs

{
  "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
  }
}

Saglabājiet atslēgu nekavējoties

Lauks key tiek atgriezts tikai šajā atbildē. To nevar izgūt vēlāk. Saglabājiet to noslēpumu pārvaldniekā (GitHub Actions secrets, HashiCorp Vault u.c.) nekavējoties.

---

API atslēgas dzēšana

Neatgriezeniski atsauc API atslēgu. Visi pieprasījumi, kas izmanto šo atslēgu, nekavējoties atgriezīs 401.

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

Pieprasījuma piemērs

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

Atbildes piemērs

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

---

API atslēgas izmantošana

Nododiet API atslēgu kā Bearer tokenu Authorization galvenē:

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

API atslēgas darbojas tāpat kā sesijas tokeni visiem galapunktiem. Tām nav derīguma termiņa, bet jūs varat tās rotēt, izveidojot jaunu atslēgu un dzēšot veco.

Ātruma ierobežojumi

API ātruma ierobežojums ir 120 pieprasījumi minūtē katrai API atslēgai. Pieprasījumi, kas pārsniedz ātruma ierobežojumu, saņem 429 Too Many Requests atbildi. Atbilde ietver Retry-After galveni, kas norāda, kad varat mēģināt atkārtoti.