Довiдник API

Aether365 API дозволяє програмно отримувати данi сканувань, запускати сканування та керувати tenant'ами, а також керувати AI Pilot - генерувати, переглядати та застосовувати автоматичнi виправлення, зчитувати сигнали ризику iдентичностi й посилювати полiтики.

Групи endpoint'iв

Область	Що охоплює
Сканування	Запуск i перелiк сканувань вiдповiдностi та exposure
Результати	Зчитування окремих результатiв сканування
AI Pilot	Генерування, перегляд i застосування планiв автоматичного виправлення
Threat Alerts	Сигнали ризику iдентичностi та стримування користувача в один клiк
Полiтики	Зчитування стану полiтик i посилення полiтик зi списку дозволених
Tenant'и	Зчитування та оновлення профiлю tenant'а
Пiдключення	Керування пiдключеними tenant'ами Microsoft 365
Заплановане сканування	Автоматизацiя повторюваних сканувань

Базова URL-адреса

https://api.aether365.io

Усi endpoint'и вказуються вiдносно цiєї базової URL-адреси.

Автентифiкацiя

API використовує автентифiкацiю Bearer-токеном. Додайте дiйсний JWT-токен у заголовок Authorization кожного запиту:

Authorization: Bearer <token>

Токени видаються системою автентифiкацiї Aether365. Див. Автентифiкацiя для отримання токена.

Формат вiдповiдей

Усi вiдповiдi API мають однакову JSON-структуру.

Успiшна вiдповiдь

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

Для endpoint'iв зi списками:

{
  "success": true,
  "data": [],
  "meta": {
    "total": 142,
    "page": 1,
    "limit": 20
  }
}

Для endpoint'iв дiй (запуск, видалення):

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

Вiдповiдь з помилкою

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description",
    "details": {}
  }
}

HTTP-коди стану

Код	Значення
200	Успiх
201	Ресурс створено
400	Невалiдний запит - вiдсутнi або некоректнi параметри
401	Потрiбна автентифiкацiя або токен недiйсний
403	Доступ заборонено - порушення iзоляцiї tenant
404	Ресурс не знайдено
409	Конфлiкт - наприклад, сканування вже виконується
429	Досягнуто лiмiту плану
500	Внутрiшня помилка сервера

Коди помилок

Код	Опис
AUTH_MISSING_TOKEN	Заголовок Authorization вiдсутнiй
AUTH_INVALID_TOKEN	Токен не вдалося перевiрити
AUTH_EXPIRED_TOKEN	Термiн дiї токена закiнчився
TENANT_NOT_FOUND	Tenant не iснує
TENANT_NOT_CONNECTED	Згода Microsoft не завершена
SCAN_NOT_FOUND	Сканування з таким ID не iснує
SCAN_ALREADY_RUNNING	Сканування вже виконується для цього tenant
SCAN_PLAN_LIMIT_REACHED	Квота сканувань поточного плану вичерпана
VALIDATION_ERROR	Тiло запиту або параметри запиту невалiднi
INTERNAL_ERROR	Непередбачена помилка сервера

Обмеження частоти запитiв

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