Skip to content

API-avaimet

Yllapitaja: Aether365-tiimi Kohderyhma: Kehittajat Laajuus: API-avainten hallintapaatepisteet

API-avaimilla todennetaan REST API -pyynnot ilman kayttajaistuntoa.

Jokainen API-avain on sidottu sen luoneeseen vuokralaistiliin. API-avaimilla on sama kayttooikeustaso kuin tiimijasenella - ne voivat lukea ja kirjoittaa kaikkia vuokralaisen tietoja mutta eivat voi muuttaa laskutusta tai suunnitelma-asetuksia.

Listaa API-avaimet

Palauttaa kaikki vuokralaisen aktiiviset API-avaimet.

GET /tenants/me/api-keys

INFO

Turvallisuussyista taydellinen avainarvo palautetaan vain kerran - luontihetkella. Myohemmat listauspyynnot nayttavat vain avaimen etuliitteen ja metatiedot.

Esimerkkipyynto

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

Esimerkkivastaus

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

Vastauksen kentat

KenttaTyyppiKuvaus
idstringAvaimen tunniste
namestringNayttonimi
prefixstringAvaimen 12 ensimmaista merkkia (tunnistusta varten)
createdAtstringISO 8601 -aikaleima
lastUsedAtstring tai nullISO 8601 -aikaleima viimeisesta todennetusta pyynnosta

Luo API-avain

Luo uuden API-avaimen. Taydellinen avainarvo palautetaan kerran eika sitä voi hakea myohemmin.

POST /tenants/me/api-keys

Pyynnon runko

json
{
  "name": "CI pipeline"
}
KenttaTyyppiPakollinenKuvaus
namestringKyllaAvaimen nayttonimi

Esimerkkipyynto

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

Esimerkkivastaus

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

Tallenna avain valittomasti

key-kentta palautetaan vain tassa vastauksessa. Sita ei voi hakea myohemmin. Tallenna se salaisuuksien hallintaan (GitHub Actions secrets, HashiCorp Vault jne.) valittomasti.


Poista API-avain

Peruuttaa pysyvasti API-avaimen. Kaikki tata avainta kayttavat pyynnot palauttavat 401 valittomasti.

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

Esimerkkipyynto

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

Esimerkkivastaus

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

API-avaimen kayttaminen

Valita API-avain Bearer-tokenina Authorization-otsikossa:

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

API-avaimet toimivat samalla tavalla kuin istuntotokenit kaikissa paatepisteissa. Ne eivat vanhene, mutta voit kierrattaa niita luomalla uuden avaimen ja poistamalla vanhan.

Nopeusrajoitukset

API:n nopeusrajoitus on 120 pyyntoa minuutissa per API-avain. Rajan ylittavat pyynnot saavat 429 Too Many Requests -vastauksen. Vastaus sisaltaa Retry-After-otsikon, joka ilmoittaa milloin voit yrittaa uudelleen.

Oliko tästä sivusta hyötyä?