Ratelimit: merge topics

Author: z-amini

source/includes/_general_notes.md

@@ -56,30 +56,6 @@
 429 | Too Many Requests     | تعداد درخواست بیشتر از اندازه مجاز است                                                            | <a target="_blank" rel="nofollow" href="https://http.cat/429">🐱</a>
 500 | Internal Server Error | مشکلی به صورت موقت در سرور نوبیتکس رخ داده است                                                    | <a target="_blank" rel="nofollow" href="https://http.cat/500">🐱</a>
 
-<h2 id="ratelimit">محدودیت فراخوانی</h2>
-> نمونه پاسخ ناموفق:
-
-``` json
-{
-  "status": "failed",
-  "code": "TooManyRequests",
-  "message": "تعداد درخواست شما بیش از حد معمول تشخیص داده شده. لطفا 12 ثانیه صبر نمایید.",
-  "backOff": 12,
-  "limit": 60
-}
-```
-
-در کنار توضیحات هر API، _محدودیت فراخوانی_ مشخصی برای هر کاربر، IP، توکن و... تعریف شده است.
-این محدودیت به‌صورت حداکثر تعداد فراخوانی در یک بازه زمانی تعیین می‌شود.
-
-در صورتی که تعداد درخواست‌ها از این محدودیت فراتر رود، خطای `TooManyRequests` بازگردانده خواهد شد.
-برای ارسال مجدد درخواست به همان آدرس، لازم است به اندازه مقدار مشخص‌شده در پارامتر `backOff` (به واحد ثانیه) صبر کنید.
-
-در زمان‌های ازدحام شدید بازار، به‌منظور ایجاد فرصت برابر برای همه کاربران، ممکن است محدودیت فراخوانی یک API برای هر کاربر کاهش یابد.
-پارامتر `limit` به تشخیص این وضعیت از حالت عادی کمک می‌کند.
-
-نادیده گرفتن محدودیت فراخوانی به دفعات زیاد، موجب اعمال محدودیت فراخوانی روی توکن کاربر به مدت ۲ دقیقه در تمامی APIها خواهد شد.
-
 <h2 id="pagination">صفحه‌بندی</h2>
 پارامترهای زیر در API های دریافت لیست دارای صفحه‌بندی قابل استفاده است:
 
@@ -114,23 +90,51 @@
 به خصوص در هنگام دریافت توکن از API لاگین، علاوه بر سایر پارامترها، رمز یک‌بار مصرف خود را نیز در هدرهای درخواست به این صورت ارسال نمایید:
 `X-TOTP: 123456`.
 
-<h2 id="ratelimits"> محدودیت‌های فراخوانی API</h2>
+<h2 id="ratelimit">محدودیت فراخوانی</h2>
+> نمونه پاسخ ناموفق:
+
+``` json
+{
+  "status": "failed",
+  "code": "TooManyRequests",
+  "message": "تعداد درخواست شما بیش از حد معمول تشخیص داده شده. لطفا 12 ثانیه صبر نمایید.",
+  "backOff": 12,
+  "limit": 60
+}
+```
+
 برخی از APIهای نوبیتکس دارای محدودیت تعداد فراخوانی در هر بازه‌ی زمانی هستند. با این حال اگر شما به صورت معمولی و مشابه
 استفاده‌ی متداول کاربران از API استفاده کنید، با این محدودیت‌ها مواجه نخواهید شد. محدودیت‌ها به ازای هر API مستقلا محاسبه
-و اعمال می‌شوند. محدودیت‌ها معمولا بر اساس آدرس IP درخواست دهنده و در موارد هم بر اساس کاربر (توکن) درخواست دهنده می‌باشند.
-در حالتی که به حد مجاز تعداد فراخوانی یک API رسیده باشید، پاسخ آن API به شما یک پیام خطا با کد 403 و دارای توضیحات مشخص
-در خصوص آن محدودیت خواهد بود.
+و اعمال می‌شوند. محدودیت‌ها معمولا بر اساس آدرس IP درخواست دهنده و در برخی موارد هم بر اساس کاربر (توکن) درخواست دهنده می‌باشند.
+
+در صورتی که تعداد درخواست‌ها از این محدودیت فراتر رود، خطای `TooManyRequests` با کد 429 در پاسخ بازگردانده می‌شود که
+همراه با توضیحات مشخص در خصوص آن محدودیت است.
+
+برای ارسال مجدد درخواست به همان آدرس، لازم است به اندازه مقدار مشخص‌شده در پارامتر `backOff` (به واحد ثانیه) صبر کنید.
+پارامتر `limit` سقف مجاز تعداد درخواست را در بازه مشخص‌شده نشان می‌دهد.
+
+<aside class="info">
+نادیده گرفتن محدودیت فراخوانی به دفعات زیاد و تکرار بی‌امان درخواست‌ها، موجب مسدودی توکن کاربر به مدت ۲ دقیقه
+در تمامی APIها خواهد شد.
+</aside>
+
+محدودیت‌های استفاده از APIها بر اساس ظرفیت پردازشی نوبیتکس یا به منظور حفظ امنیت برای هر کاربر تعیین می‌شود 
+تا کیفیت خدمات برای همه کاربران به‌طور یکنواخت حفظ گردد. در زمان‌های ازدحام شدید بازار، به‌منظور ایجاد فرصت برابر برای
+همه کاربران، ممکن است محدودیت فراخوانی یک API به ازای یک کاربر کاهش یابد.
 
-در صورتی که به صورت موردی یا در حین تست کد خود به محدودیتی برخورد کردید، می‌توانید با
-منتظر ماندن (بین یک ساعت تا یک روز) آن محدودیت را برطرف کنید و دوباره امکان استفاده از API مد نظرتان را داشته باشید. اگر به
-صورت مداوم به محدودیتی برای یک API برخورد می‌کنید و فکر می‌کنید که بهتر است تعداد فراخوانی مجاز آن API افزایش یابد، حتما با
-ایجاد یک مورد در گیت‌هاب ([لینک ایجاد مورد](https://github.com/nobitex/docs-api/issues/new)) مسئله را با ما مطرح نمایید.
+اگر به صورت مداوم با محدودیتی در استفاده از یک API مواجه می‌شوید و بر این باور هستید که افزایش تعداد فراخوانی مجاز 
+آن API مفید خواهد بود، لطفا از طریق ایجاد یک [مسئله در گیت‌هاب](https://github.com/nobitex/docs-api/issues/new) 
+درخواست خود را با ما در میان بگذارید.
 
 <h3 id="order_ratelimit">محدودیت مشترک APIهای سفارش‌گذاری</h3>
 توجه داشته باشید که تمامی API‌های مربوط به ثبت سفارش دارای محدودیت مشترک روی تعداد سفارش‌هایی که ثبت می‌شوند هستند. برای مثال، اگر همزمان هم در بازار اسپات و هم در بازار تعهدی سفارش ثبت می‌کنید، محدودیت فراخوانی شامل مجموع سفارش‌های ثبت شده در این دو بازار می‌شود.
 
 مقدار محدودیت مشترک: ۳۰۰ درخواست در ۱۰ دقیقه
 
+<h3 id="auth_ratelimit">محدودیت احراز ناموفق</h3>
+به منظور حفاظت از امنیت حساب‌های کاربران، در صورتی که بیش از ۱۰۰ درخواست با توکن اشتباه (یا منقضی) از یک آدرس IP 
+در مدت زمان کمتر از ۳۰ دقیقه ارسال شود، آن IP تا پایان این بازه زمانی مسدود خواهد شد. برای پیشگیری از بروز این مسئله،
+توصیه می‌شود فرایند تولید و تجدید توکن خود را مطابق با توضیحات [احراز هویت](/#auth) مدیریت نمایید.
 
 
 ## حالت متداول و Pro