Dokumentacja API

Autor: Zespół Aether365 Odbiorcy: Deweloperzy i inżynierowie DevOps Zakres: Przegląd REST API Aether365, bazowy URL i format odpowiedzi

REST API Aether365 umożliwia programistyczny dostęp do danych skanów, uruchamianie skanów, zarządzanie tenantami oraz sterowanie AI Pilot: generowanie, przeglądanie i stosowanie automatycznej remediacji, odczyt sygnałów ryzyka tożsamości i wzmacnianie zasad.

Grupy punktów końcowych

Obszar	Co obejmuje
Skany	Uruchamianie i listowanie skanów zgodności i ekspozycji
Wyniki	Odczyt pojedynczych wyników skanu
AI Pilot	Generowanie, przeglądanie i stosowanie automatycznych planów remediacji
Threat Alerts	Sygnały ryzyka tożsamości i powstrzymanie użytkownika jednym kliknięciem
Zasady	Odczyt stanu zasad i wzmacnianie zasad z listy dozwolonych
Tenanci	Odczyt i aktualizacja profilu tenanta
Połączenia	Zarządzanie połączonymi tenantami Microsoft 365
Zaplanowane skany	Automatyzacja cyklicznych skanów

Bazowy URL

https://api.aether365.io

Wszystkie endpointy są relatywne do tego bazowego URL.

Uwierzytelnianie

API korzysta z uwierzytelniania tokenem Bearer. Dołącz ważny token JWT w nagłówku Authorization każdego żądania:

Authorization: Bearer <token>

Tokeny są wydawane przez system uwierzytelniania Aether365. Szczegóły uzyskiwania tokena znajdziesz w sekcji Uwierzytelnianie.

Format odpowiedzi

Wszystkie odpowiedzi API mają spójną strukturę JSON.

Odpowiedź pomyślna

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

Dla endpointów listowych:

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

Dla endpointów akcji (trigger, delete):

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

Odpowiedź błędu

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

Kody statusu HTTP

Kod	Znaczenie
200	Sukces
201	Zasób utworzony
400	Nieprawidłowe żądanie - brakujące lub błędne parametry
401	Wymagane uwierzytelnienie lub nieprawidłowy token
403	Odmowa dostępu - naruszenie izolacji tenanta
404	Zasób nie znaleziony
409	Konflikt - np. skan jest już w trakcie realizacji
429	Osiągnięto limit planu
500	Wewnętrzny błąd serwera

Kody błędów

Kod	Opis
AUTH_MISSING_TOKEN	Brak nagłówka Authorization
AUTH_INVALID_TOKEN	Nie udało się zweryfikować tokena
AUTH_EXPIRED_TOKEN	Token wygasł
TENANT_NOT_FOUND	Tenant nie istnieje
TENANT_NOT_CONNECTED	Nie ukończono procesu Microsoft consent
SCAN_NOT_FOUND	Identyfikator skanu nie istnieje
SCAN_ALREADY_RUNNING	Skan jest już w trakcie realizacji dla tego tenanta
SCAN_PLAN_LIMIT_REACHED	Wyczerpano limit skanów dla bieżącego planu
VALIDATION_ERROR	Treść żądania lub parametry zapytania są nieprawidłowe
INTERNAL_ERROR	Niespodziewany błąd serwera

Limity żądań

API jest ograniczone do 120 żądań na minutę. Przekroczenie limitu zwraca 429 Too Many Requests. Nagłówek Retry-After wskazuje, ile sekund należy poczekać przed ponowną próbą.