Skip to content

API ključi

API ključi se uporabljajo za preverjanje pristnosti zahtev na REST API brez uporabniške seje.

Vsak API ključ je vezan na račun najemnika, ki ga je ustvaril. API ključi imajo enak dostop kot član ekipe - lahko berejo in pišejo vse podatke najemnika, ne morejo pa spreminjati nastavitev obračunavanja ali paketa.

Seznam API ključev

Vrne vse aktivne API ključe za najemnika.

GET /tenants/me/api-keys

INFO

Iz varnostnih razlogov se polna vrednost ključa vrne le enkrat - ob ustvarjanju. Poznejše zahteve seznama prikazujejo le predpono ključa in metapodatke.

Primer zahteve

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

Primer odgovora

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

Polja odgovora

PoljeVrstaOpis
idstringIdentifikator ključa
namestringPrikazno ime
prefixstringPrvih 12 znakov ključa (za identifikacijo)
createdAtstringČasovni žig ISO 8601
lastUsedAtstring ali nullČasovni žig ISO 8601 zadnje overjene zahteve

Ustvarjanje API ključa

Ustvari nov API ključ. Polna vrednost ključa se vrne enkrat in je pozneje ni mogoče pridobiti.

POST /tenants/me/api-keys

Telo zahteve

json
{
  "name": "CI pipeline"
}
PoljeVrstaZahtevanoOpis
namestringDaPrikazno ime za ključ

Primer zahteve

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

Primer odgovora

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

Ključ takoj shranite

Polje key se vrne le v tem odgovoru. Pozneje ga ni mogoče pridobiti. Takoj ga shranite v upravitelja skrivnosti (GitHub Actions secrets, HashiCorp Vault itd.).


Brisanje API ključa

Trajno prekliče API ključ. Vse zahteve s tem ključem bodo takoj vrnile 401.

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

Primer zahteve

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

Primer odgovora

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

Uporaba API ključa

API ključ posredujte kot žeton Bearer v glavi Authorization:

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

API ključi delujejo enako kot žetoni seje za vse končne točke. Ne potečejo, lahko pa jih rotirate tako, da ustvarite novega in izbrišete starega.

Omejitve hitrosti

API je omejen na 120 zahtev na minuto na API ključ. Zahteve, ki presežejo omejitev, prejmejo odgovor 429 Too Many Requests. Odgovor vključuje glavo Retry-After, ki pove, kdaj lahko ponovite poskus.

Je bila ta stran uporabna?