Coduri eroare API REST
Statusul procesării unei cereri API se transmite către client ca și status al răspunsului http, folosind codurile standard definite în protocolul http. Cererile procesate corect vor avea statusul 200 (OK). Cererile procesate incorect vor avea unul dintre statusurile definite mai jos.
Atunci când apare o eroare în procesarea cererii, Accolades va adăuga informații despre eroare în jurnalul contului, disponibil în tabul Jurnal din fișa contului.
Status: 400 (Bad request)
Parametrii furnizați prin POST nu respectă specificațiile definite în cerere. Eroarea se înregistrează în jurnalul contului.
Raspunsul furnizat este în format JSON și are următorul conținut:
{
"type" : "Error",
"message" : "Bad request",
"code" : "400"
}
Status: 401 (Unauthorized)
Informațiile pentru autentificare sunt incorecte. Există 3 cazuri în care serverul întoarce această eroare:
- Numărul contului furnizat în URL nu este valid, caz în care eroarea NU se înregistrează în jurnalul contului (deoarece contul nu există).
- Contul există dar nu are modulul API activ, caz în care eroarea NU se înregistrează în jurnalul contului.
- Numărul contului este valid, API pe cont este activ însă parola furnizată nu este corectă, caz în care eroarea va apărea și în jurnalul contului.
Răspunsul furnizat este în format JSON și are următorul conținut:
{
"type" : "Error",
"message" : "Unauthorized",
"code" : "401"
}
Status: 403 (Forbidden)
Serverul refuză procesarea cererii, din cauza faptului că IP-ul de la care a venit cererea este temporar blocat (prea multe cereri eronate de la IP). Eroarea NU se înregistrează în jurnalul contului (serverul verifică IP-ul și blochează cererea, nu realizează nicio altă operație suplimentară).
Răspunsul furnizat este în format JSON și are următorul conținut:
{
"type" : "Error",
"message" : "IP address rejected",
"code" : "403.6"
}
Status: 404 (Not found)
Serverul a primit o cerere pentru un url care nu există. Eroarea NU se înregistrează în jurnalul contului (serverul nu procesează cereri către resurse inexistente).
Răspunsul furnizat este în format JSON și are următorul conținut:
{
"type" : "Error",
"message" : "Not found",
"code" : "404"
}
Status: 413 (Payload Too Large)
Cererea transmisă către server depășește dimensiunea maximă acceptată.
Răspunsul furnizat este în format JSON și are următorul conținut:
{
"type" : "Error",
"message" : "Payload Too Large",
"code" : "413"
}
Status: 500 (Internal server error)
A apărut o eroare în aplicația care procesează cererea. În acest caz trebuie să contactați VoIPIT pentru verificarea cererii. Eroarea POATE să apară în jurnalul contului.
Dacă răspunsul furnizat este în format JSON atunci acesta va avea următorul conținut:
{
"type" : "Error",
"message" : "Internal server error",
"code" : "500"
}