Klaidų kodai

Prižiūri: Aether365 komanda Auditorija: Kūrėjai ir IT administratoriai Apimtis: Pilnas Aether365 API klaidų kodų žinynas

Visos API klaidos grąžina nuoseklią JSON struktūrą:

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

Autentifikavimas

Kodas	HTTP	Reikšmė	Sprendimas
AUTH_MISSING_TOKEN	401	Užklausoje nėra Authorization antraštės	Kiekvienoje užklausoje įtraukite Authorization: Bearer <token>
AUTH_INVALID_TOKEN	401	Nepavyko patvirtinti JWT	Patikrinkite, ar prieigos raktas nėra netaisyklingas ar nukirstas
AUTH_EXPIRED_TOKEN	401	JWT galiojimas pasibaigė	Gaukite naują prieigos raktą prisijungdami iš naujo arba atnaujindami seansą
AUTH_INSUFFICIENT_SCOPE	403	Autentifikuota paskyra neturi leidimo šiam veiksmui	Patikrinkite, ar naudojate paskyrą su reikiama role

Įgaliojimas

Kodas	HTTP	Reikšmė	Sprendimas
TENANT_ACCESS_DENIED	403	Užklausa bandė pasiekti kito nuomininko duomenis	Įprasto naudojimo metu tai neturėtų įvykti - jei tai matote, kreipkitės į pagalbą
AUTH_INSUFFICIENT_SCOPE	403	Nepakanka leidimų šiam veiksmui	Patikrinkite, ar naudojate paskyrą su reikiama role

Nuomininkas

Kodas	HTTP	Reikšmė	Sprendimas
TENANT_NOT_FOUND	404	Šiam naudotojui nėra nuomininko paskyros	Sukurkite paskyrą adresu app.aether365.io
TENANT_NOT_CONNECTED	400	Microsoft 365 administratoriaus sutikimas nebaigtas	Prijunkite nuomininką per Nuostatos > Prisijungimai

Nuskaitymai

Kodas	HTTP	Reikšmė	Sprendimas
SCAN_NOT_FOUND	404	Nuskaitymo ID neegzistuoja arba priklauso kitam nuomininkui	Patikrinkite nuskaitymo ID
SCAN_ALREADY_RUNNING	409	Šiam nuomininkui nuskaitymas jau vykdomas	Palaukite, kol esamas nuskaitymas bus baigtas
SCAN_PLAN_LIMIT_REACHED	429	Nuskaitymų kvota išnaudota	Palaukite kito atsiskaitymo laikotarpio arba kreipkitės į pagalbą
SERVICE_UNAVAILABLE	503	Platforma veikia techninės priežiūros režimu	Patikrinkite būseną ir bandykite dar kartą pasibaigus priežiūrai

Prisijungimai

Kodas	HTTP	Reikšmė	Sprendimas
CONNECTION_NOT_FOUND	404	Prisijungimo ID neegzistuoja	Patikrinkite prisijungimo ID
CANNOT_REMOVE_LAST_CONNECTION	409	Negalima pašalinti vienintelio likusio prisijungimo	Prieš pašalindami šį, pridėkite kitą prisijungimą

Komandos nariai

Kodas	HTTP	Reikšmė	Sprendimas
MEMBER_LIMIT_REACHED	429	Pasiektas narių limitas	Kreipkitės į pagalbą, kad pridėtumėte daugiau narių
MEMBER_ALREADY_EXISTS	409	El. paštas jau turi aktyvų ar laukiantį kvietimą	Patikrinkite esamą narių sąrašą

Suplanuoti nuskaitymai

Kodas	HTTP	Reikšmė	Sprendimas
SCAN_PLAN_LIMIT_REACHED	429	Pasiektas pasirinktinio tvarkaraščio limitas	Ištrinkite esamą tvarkaraštį arba kreipkitės į pagalbą

Tikrinimas

Kodas	HTTP	Reikšmė
VALIDATION_ERROR	400	Užklausos turinys ar užklausos parametras netaisyklingas. Laukas details išvardija konkrečius netaisyklingus laukus.

Serverio klaidos

Kodas	HTTP	Reikšmė	Sprendimas
INTERNAL_ERROR	500	Netikėta serverio klaida	Pakartokite užklausą. Jei klaida išlieka, kreipkitės į pagalbą nurodydami užklausos ID iš atsakymo antraščių.

Užklausų dažnio ribos

Kai viršijate API užklausų dažnio ribą, API grąžina:

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Retry after 60 seconds."
  }
}

HTTP būsena: 429 Too Many Requests Antraštė: Retry-After: 60

Dabartinės dažnio ribos: 120 užklausų per minutę vienam API raktui.