فرمت خطای API عمومی
خطاهای مسیرهای غیر Integration (مثل /api/auth و /api/classes) این ساختار flat را دارند. خطاهای Integration API ساختار تودرتو با error.messageFa دارند — مستندات Integration.
{
"error": "نشست شما منقضی شده است",
"message": "نشست شما منقضی شده است",
"code": "UNAUTHORIZED",
"requestId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errorFa": "نشست شما منقضی شده است",
"hintFa": "لطفاً دوباره وارد حساب کاربری شوید.",
"severity": "warning"
}کدهای پرتکرار
| code | HTTP | دسته | پیام فارسی | راهنما |
|---|---|---|---|---|
| UNAUTHORIZED | 401 | احراز هویت | نشست شما منقضی شده است | دوباره وارد شوید. |
| FORBIDDEN | 403 | دسترسی | اجازهٔ انجام این کار را ندارید | — |
| NOT_FOUND | 404 | عمومی | مورد درخواستی پیدا نشد | — |
| BAD_REQUEST | 400 | اعتبارسنجی | اطلاعات ارسالی کامل نیست | — |
| VALIDATION_ERROR | 400 | اعتبارسنجی | اعتبارسنجی درخواست ناموفق بود | — |
| OTP_INVALID | 400 | احراز هویت | کد OTP نامعتبر یا منقضی شده است | — |
| RATE_LIMITED | 429 | محدودیت | درخواستهای شما زیاد است | چند دقیقه صبر کنید. |
| RATE_LIMIT_EXCEEDED | 429 | Integration | محدودیت نرخ API | — |
| CLASS_NOT_FOUND | 404 | کلاس | این کلاس دیگر در دسترس نیست | — |
| NOT_MEMBER | 403 | کلاس | شما عضو این کلاس نیستید | — |
| MAX_CLASSES | 409 | سهمیه | سقف تعداد کلاس پر شده است | — |
| MAX_STUDENTS | 409 | سهمیه | سقف تعداد دانشآموز پر شده است | — |
| SUBSCRIPTION_EXPIRED | 402 | اشتراک | اشتراک منقضی شده است | — |
| GATEWAY_TIMEOUT | 504 | زیرساخت | زمان اتصال به سرویس به پایان رسید | — |
| SERVICE_UNAVAILABLE | 503 | زیرساخت | سرویس موقتاً در دسترس نیست | — |
| INTERNAL_ERROR | 500 | سرور | مشکلی در سمت سرور رخ داد | شناسهٔ پیگیری را برای پشتیبانی بفرستید. |