U یونیوم مستندات

هسته یونیوم

مصرف، پلن و محدودیت‌ها

فهم usage، limitها و مسیرهای پلن برای ظرفیت‌سنجی و billing.

مسیرهای مهم

مسیر کاربرد
GET /user/me خلاصه حساب، پلن و محدودیت‌ها
GET /user/usage جزئیات مصرف ماه جاری
GET /plans فهرست پلن‌های قابل مشاهده
GET /notifications اعلان‌های مرتبط با حساب یا پلن

نمونه usage

curl "https://api.uniom.ir/user/usage" \
  -H "Authorization: Bearer <JWT>"

چه چیزهایی را باید بخوانید؟

فیلد معنی
messages_sent تعداد عملیات ارسال
messages_received تعداد عملیات دریافت
messages_edited تعداد ویرایش‌ها
total_operations جمع عملیاتی که برای پلن مهم است
limit سقف ماه جاری اگر محدود باشد
remaining ظرفیت باقی‌مانده
percentage_used درصد مصرف

کاربرد عملی

  • اگر consumer شما polling سنگین یا webhook پرحجم دارد، usage را در کنار throughput ببینید.
  • برای production، alert خود را فقط بر اساس خطا نسازید؛ نزدیک‌شدن به limit هم باید دیده شود.
  • اگر چند credential دارید، نام‌گذاری API keyها را طوری نگه دارید که usage و owner هر کدام مشخص بماند.

بخش‌های مرتبط