API nuoroda

Autorius: Aether365 komanda Auditorija: Kūrėjai ir DevOps inžinieriai Apimtis: Aether365 REST API apžvalga, bazinis URL ir atsakymo formatas

Aether365 API leidžia programiškai pasiekti nuskaitymo duomenis, inicijuoti nuskaitymus, valdyti organizacijas ir valdyti AI Pilot - generuoti, peržiūrėti ir taikyti automatinius ištaisymus, skaityti tapatybės rizikos signalus ir sustiprinti politikas.

Galutinių taškų grupės

| Sritis | Ką apima | | Nuskaitymai | Inicijuoti ir išvardyti atitikties bei pažeidžiamumo nuskaitymus | | Rezultatai | Skaityti atskirus nuskaitymo radinius | | AI Pilot | Generuoti, peržiūrėti ir taikyti automatinius ištaisymo planus | | Threat Alerts | Tapatybės rizikos signalai ir vieno paspaudimo naudotojo izoliavimas | | Politikos | Skaityti politikų būklę ir sustiprinti leistinas politikas | | Organizacijos | Skaityti ir atnaujinti organizacijos profilį | | Ryšiai | Valdyti prijungtas Microsoft 365 organizacijas | | Suplanuoti nuskaitymai | Automatizuoti pasikartojančius nuskaitymus |

Bazinis URL

https://api.aether365.io

Visi galutiniai taškai yra santykiniai šiam baziniam URL.

Autentifikavimas

API naudoja Bearer token autentifikavimą. Kiekvienoje užklausoje įtraukite galiojantį JWT tokeną į Authorization antraštę:

Authorization: Bearer <token>

Tokenai išduodami Aether365 autentifikavimo sistemos. Žr. Autentifikavimas tokeno gavimo detalėms.

Atsakymo formatas

Visi API atsakymai naudoja nuoseklią JSON struktūrą.

Sėkmingas atsakymas

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

Sąrašų galutiniams taškams:

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

Veiksmų galutiniams taškams (paleidimas, trynimas):

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

Klaidos atsakymas

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Žmogui suprantamas aprašymas",
    "details": {}
  }
}

HTTP būsenos kodai

Kodas	Reikšmė
200	Sėkmė
201	Išteklius sukurtas
400	Neteisinga užklausa - trūkstami ar neteisingi parametrai
401	Būtinas autentifikavimas arba tokenas neteisingas
403	Prieiga uždrausta - organizacijų izoliacijos pažeidimas
404	Išteklius nerastas
409	Konfliktas - pavyzdžiui, nuskaitymas jau vykdomas
429	Pasiektas plano limitas
500	Vidinė serverio klaida

Klaidų kodai

Kodas	Aprašymas
AUTH_MISSING_TOKEN	Authorization antraštė nepateikta
AUTH_INVALID_TOKEN	Tokeno nepavyko patikrinti
AUTH_EXPIRED_TOKEN	Tokenas nebegalioja
TENANT_NOT_FOUND	Organizacija neegzistuoja
TENANT_NOT_CONNECTED	Microsoft sutikimas neužbaigtas
SCAN_NOT_FOUND	Nuskaitymo ID neegzistuoja
SCAN_ALREADY_RUNNING	Nuskaitymas jau vykdomas šiai organizacijai
SCAN_PLAN_LIMIT_REACHED	Nuskaitymų kvota dabartiniam planui išnaudota
VALIDATION_ERROR	Užklausos turinys ar užklausos parametrai neteisingi
INTERNAL_ERROR	Nenumatyta serverio klaida

Užklausų limitai

API apribotas iki 120 užklausų per minutę. Viršijus limitą, grąžinamas 429 Too Many Requests. Retry-After antraštė nurodo, kiek sekundžių palaukti prieš pakartojant.