کد وضعیت ها و خطاها

کدهای وضعیت HTTP

کد	توضیحات
200	عملیات با موفقیت انجام شد
401	توکن وجود ندارد یا نامعتبر است
403	خطای دسترسی
400	درخواست نامعتبر
404	دیتای مورد نظر یافت نشد
422	مقادیر ورودی به درستی وارد نشده است
500	خطای داخلی سرور لطفا این مورد را به پشتیبانی اطلاع دهید

کدهای پاسخ API

تمامی پاسخ‌های API شامل فیلدهای زیر هستند:

{
    "code": 100,        // کد وضعیت داخلی
    "msg": "OK",        // پیام وضعیت
    "data": {}          // داده‌های پاسخ
}

کدهای موفقیت

کد	پیام	توضیحات
100	OK	درخواست با موفقیت انجام شد

کدهای خطا

کد	پیام	توضیحات
400	Bad Request	درخواست نامعتبر
401	Unauthorized	احراز هویت ناموفق
403	Forbidden	دسترسی مجاز نیست
404	Not Found	منبع یافت نشد
429	Too Many Requests	تعداد درخواست‌ها بیش از حد مجاز
500	Internal Server Error	خطای داخلی سرور

شرایط استفاده

هشدار مهم

• در نظر داشته باشید که تنها بخش‌هایی که در مستندات API اوکی اکسچنج ذکر شده باشند، API عمومی و قابل استفاده در اوکی اکسچنج محسوب می‌شوند
• اگر endpoint یا هر فیلدی در مستندات ذکر نشده باشد، ممکن است بدون اطلاع قبلی دچار تغییر شود

نکات مهم

• این امکان وجود دارد که در طول زمان تغییراتی در API عمومی اوکی اکسچنج به وجود آید
• تغییرات در بخش «سابقه تغییرات API اوکی اکسچنج» اطلاع‌رسانی خواهند شد
• لازم است استفاده کنندگان به صورت منظم این بخش را رصد نمایند

محدودیت‌های امنیتی

• در صورتی که پاسخی مبنی بر استفاده نادرست از API مانند خطای 429 دریافت شود، استفاده کننده ملزم است که واکنش مناسبی نشان دهد
• حملات DDOS یا هرگونه اعمال مخرب خلاف شرایط استفاده است
• در صورت مشاهده، تمامی حساب‌های کاربری مرتبط مسدود خواهند شد

فرمت پاسخ‌ها

• به طور معمول خروجی API به صورت JSON ارائه می‌شود
• ممکن است فیلدهای اضافی نیز در خروجی پاسخ وجود داشته باشد
• پیشنهاد می‌شود که برنامه خود را به شکلی توسعه دهید که در صورت وجود فیلدهای اضافی، عملکرد آن دچار خطا نشود

سابقه تغییرات

1401/02/10

• راه اندازی بخش مستندات
• اضافه کردن وب سرویس به بخش تبادل سریع

1401/04/15

• اضافه کردن وب سرویس به بخش بازار حرفه ای

1401/10/07

• راه اندازی بخش API Key
• امکان کار با بخش های مربوط به حساب کاربری

1402/06/11

• اضافه کردن وب سرویس های estimate و convert

1404/06/25

• اضافه کردن مستندات کامل بازار اسپات (حرفه‌ای)
• اضافه کردن وب سرویس‌های لیست نمادهای معاملاتی و تیکر تمام نمادها
• راه‌اندازی مستندات API عمومی بازار فیوچرز (تعهدی)
• اضافه کردن وب سرویس‌های بررسی سلامت سیستم، تست اتصال و زمان سرور
• بهبود مستندات احراز هویت و API Key