API-nycklar

Underhålls av: Aether365 Team Målgrupp: Utvecklare Omfattning: API-nyckelhanteringsendpoints

API-nycklar används för att autentisera begäranden till REST API utan en användarsession.

Varje API-nyckel är knuten till det tenant-konto som skapade den. API-nycklar har samma åtkomst som en teammedlem - de kan läsa och skriva all tenant-data men kan inte ändra fakturering eller planinställningar.

Lista API-nycklar

Returnerar alla aktiva API-nycklar för tenanten.

GET /tenants/me/api-keys

INFO

Av säkerhetsskäl returneras det fullständiga nyckelvärdet bara en gång - vid skapandet. Efterföljande listbegäranden visar bara nyckelprefix och metadata.

Exempelbegäran

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

Exempelsvar

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

Svarsfält

Fält	Typ	Beskrivning
id	string	Nyckelidentifierare
name	string	Visningsnamn
prefix	string	Första 12 tecknen i nyckeln (för identifiering)
createdAt	string	ISO 8601-tidsstämpel
lastUsedAt	string eller null	ISO 8601-tidsstämpel för senaste autentiserade begäran

---

Skapa en API-nyckel

Skapar en ny API-nyckel. Det fullständiga nyckelvärdet returneras en gång och kan inte hämtas igen.

POST /tenants/me/api-keys

Begärandekropp

{
  "name": "CI pipeline"
}

Fält	Typ	Obligatoriskt	Beskrivning
name	string	Ja	Visningsnamn för nyckeln

Exempelbegäran

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

Exempelsvar

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

Spara nyckeln omedelbart

Fältet key returneras bara i detta svar. Det kan inte hämtas senare. Lagra den i en hemlighethanterare (GitHub Actions secrets, HashiCorp Vault osv.) omedelbart.

---

Radera en API-nyckel

Återkallar permanent en API-nyckel. Alla begäranden som använder denna nyckel returnerar 401 omedelbart.

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

Exempelbegäran

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

Exempelsvar

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

---

Använda en API-nyckel

Skicka API-nyckeln som en Bearer-token i Authorization-headern:

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

API-nycklar fungerar på samma sätt som sessionstokens för alla endpoints. De går inte ut, men du kan rotera dem genom att skapa en ny nyckel och radera den gamla.

Hastighetsbegränsningar

API:et har en hastighetsbegränsning på 120 begäranden per minut per API-nyckel. Begäranden som överskrider gränsen får ett 429 Too Many Requests-svar. Svaret inkluderar en Retry-After-header som anger när du kan försöka igen.