قوانین و شرایط استفاده از API نوبیتکس
ملاحظات استفاده عمومی
- تنها بخشی از API نوبیتکس که در مستندات ذکر شده باشند، API عمومی و قابل استفاده نوبیتکس به شمار میآیند. اگر endpoint یا فیلدی در مستندات ذکر نشده باشد، ممکن است بدون اطلاع قبلی دچار تغییر شود.
- ممکن است در طول زمان تغییراتی در API عمومی نوبیتکس رخ دهد. این تغییرات در صفحه «سابقه تغییرات API نوبیتکس» اطلاعرسانی خواهند شد. لازم است استفاده کنندگان به صورت منظم و هفتگی این صفحه را رصد نمایند و تغییرات لازم را در برنامههای خود اعمال نمایند.
- نوبیتکس تضمین سطح سرویس SLA برای API خود به عموم مشتریان ارائه نمیدهد و استفاده کنندگان از API باید تمهیدات لازم در خصوص تشخیص و واکنش به اختلالات احتمالی در سرویس را انجام دهند. نوبیتکس در قبال هیچ گونه شرایط یا تغییراتی در API که احتمالاً باعث ایجاد مشکل در کد نوشته شده توسط کاربران شود، نخواهد داشت.
- در صورت دریافت پاسخ مبنی بر استفاده نادرست از API، مانند خطای 429 یا سایر خطاهای ناشی از نرخ بالای درخواستها یا ورودی نامعتبر، استفاده کننده ملزم است که واکنش مناسب را نسبت به خطا نشان داده و از تکرار اشتباه با بسامد بالا خودداری نماید. در صورت تشخیص استفاده نادرست و عدم واکنش مناسب به پیامهای خطای دریافتی، ممکن است IP درخواست دهنده به صورت موقت یا دائمی در سرویس نوبیتکس مسدود شود.
- استفاده آگاهانه از API نوبیتکس جهت نفوذ یا حملات DDoS یا سایر اعمال مخرب خلاف شرایط استفاده نوبیتکس است و در صورت مشاهده حسابهای کاربری دخیل در آن مسدود خواهند شد.
ملاحظات برنامهنویسی
- خروجی API نوبیتکس معمولاً در قالب JSON ارائه میشود. لازم به دقت است که ممکن است علاوه بر فیلدهایی که در مستندات برای خروجی ذکر شدهاند، فیلدهای دیگری نیز در خروجی پاسخ وجود داشته باشند. پیشنهاد میشود که برنامه خود را به صورتی توسعه دهید که در صورت وجود فیلدهای دیگری علاوه بر فیلدهای مورد انتظار، دچار خطا نشود.
ملاحظات مرتبط با سرویس کلادفلر
- نوبیتکس از سرویس کلادفلر به عنوان CDN و واسط API استفاده مینماید. در صورتی که به هر دلیل کلادفلر ترافیک ارسالی شما را مشکوک یا مخرب تشخیص دهد ممکن است برخی یا تمام درخواستهای شما را رد کند. مدیریت این شرایط به دلیل اهمیت سرویس کلادفلر جهت جلوگیری از حملات DDoS ضروری و خارج از کنترل نوبیتکس است و استفاده کنندگان از API ملزم هستند نکات عمومی Fair Use را لحاظ نمایند.
- امکان استفاده از API نوبیتکس هم از آیپی داخل و هم از آیپی خارج از کشور ممکن است و محدودیتی بابت استفاده از آیپی ایرانی روی درخواستها اعمال نمیشود.
- اتصال تمامی کاربران عادی سایت و اپ و API نوبیتکس به واسطه سرویس کلادفلر با سرورهای نوبیتکس که در داخل ایران مستقر هستند، برقرار میشود و امکان ارائه کانال مستقیمتر ارتباطی وجود ندارد. کاربران میتوانند در صورت نیاز به کاهش تاخیر ارتباطی، نسبت به حداقلسازی تاخیر ارتباطی خود تا سرورهای لبه کلادفلر اقدام نمایند.