Skip to main content
#P1453

POST /api/v2/online/credit

Route Info

Method Endpoint Controller Middleware Purpose
POST /api/v2/online/credit OnlineController@credit authWithJwt دریافت مانده اعتبار آنلاین شعبه

منطق عملکرد

  • فراخوانی متد استاتیک OnlineController::getCredit(branch, action) برای واکشی اعتبار.
  • بازگرداندن پاسخ موفق با ساختار:
    {
     "status": true,
     "time": time(),
     "last_update": credit['last_update'],
     "data": credit['data']
    }

پارامترهای ورودی

نام نوع ضروری توضیح
branch integer بله شناسه شعبه درخواست‌دهنده
action string خیر نوع اقدام (پیش‌فرض "check") درصورت وجود

پاسخ نمونه

{
 "status": true,
 "time": 1732049800,
 "last_update": "2025‑11‑20 09:45:06",
 "data": {
   "credit_total": 242000000,
   "credit_used": 210000000,
   "credit_available": 32000000
 }
}

نکات امنیتی

روت فقط برای کاربران احراز هویت‌شده (authWithJwt) فعال است و اطلاعات صرفاً مربوط به شعبه درخواست‌دهنده برگردانده می‌شود.

وابستگی‌ها

به متد getCredit() در کلاس OnlineController نیاز دارد (احتمالاً منبع داده: جدول credits_online یا کِش Redis برای اعتبار به‌روز).

بهبود ممکن

  • افزودن پارامتر currency برای اجازه به نمایش ارز غیرریالی.
  • افزودن کش Time‑based (credit_cache_TTL=300s).