Довідник API

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

Групи endpoint'ів

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

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

https://api.aether365.io

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

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

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

Authorization: Bearer <token>

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

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

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

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

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

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

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

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

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

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

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

HTTP-коди стану

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

Коди помилок

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

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

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