Skip to content

API ключове

API ключовете се използват за удостоверяване на заявки към REST API без потребителска сесия.

Всеки API ключ е обвързан с акаунта на tenant-а, който го е създал. API ключовете имат същия достъп като член на екипа - могат да четат и записват всички данни на tenant-а, но не могат да променят настройки за таксуване или план.

Списък с API ключове

Връща всички активни API ключове за tenant-а.

GET /tenants/me/api-keys

INFO

От съображения за сигурност пълната стойност на ключа се връща само веднъж - при създаването. Следващите заявки за списък показват само префикса на ключа и метаданните.

Примерна заявка

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

Примерен отговор

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

Полета в отговора

ПолеТипОписание
idstringИдентификатор на ключа
namestringПоказвано име
prefixstringПървите 12 символа от ключа (за идентификация)
createdAtstringISO 8601 времеви печат
lastUsedAtstring или nullISO 8601 времеви печат на последната удостоверена заявка

Създаване на API ключ

Създава нов API ключ. Пълната стойност на ключа се връща веднъж и не може да бъде извлечена отново.

POST /tenants/me/api-keys

Тяло на заявката

json
{
  "name": "CI pipeline"
}
ПолеТипЗадължителноОписание
namestringДаПоказвано име за ключа

Примерна заявка

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

Примерен отговор

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

Запазете ключа веднага

Полето key се връща само в този отговор. То не може да бъде извлечено по-късно. Запазете го в хранилище за тайни (GitHub Actions secrets, HashiCorp Vault и др.) незабавно.


Изтриване на API ключ

Окончателно отменя API ключ. Всички заявки, използващи този ключ, ще получават 401 незабавно.

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

Примерна заявка

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

Примерен отговор

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

Използване на API ключ

Подайте API ключа като Bearer токен в заглавието Authorization:

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

API ключовете работят по същия начин като токени на сесии за всички крайни точки. Те нямат срок на валидност, но можете да ги ротирате, като създадете нов ключ и изтриете стария.

Лимити на заявките

API е ограничен до 120 заявки на минута за API ключ. Заявките, надхвърлящи лимита, получават отговор 429 Too Many Requests. Отговорът включва заглавие Retry-After, показващо кога можете да опитате отново.

Беше ли полезна тази страница?