ارتقا API ها و ساختار توکن‌ها

با توجه به ارتقا API ها در اکسیر، از نسخه ۰ (v0) به نسخه ۱ (v1)، از تاریخ ۷ خرداد ۱۳۹۹، در تمام endpoint های مربوط به API ها، مسیر v1، می بایست جایگزین مسیر v0 گردد. (اطلاعات بیشتر)
مثال: مسیر https://api.exir.io/v0/ticker به مسیر جدید https://api.exir.io/v1/ticker تغییر خواهد نمود.

در نسخه جدید اکسیر، به منظور افزایش حداکثری امنیت استفاده از API های اکسیر، با استفاده از روش HMAC-SHA256 کاربران در نهایت امنیت می توانند اقدام به توسعه برنامه و بات های معامله گر خود نمایند.

لازم به ذکر است با توجه به این ساختار جدید، توکن های API اکسیر، شامل دو بخش خواهند شد:

  • API key
  • secret key

HMAC-SHA256 یک رشته (string) و یک کلید خصوصی (secret key) را به عنوان INPUT دریافت کرده و یک خروجی signature (api-signature) آن را بر می گرداند.

رشته ای که به عنوان INPUT به این تابع داده می شود شامل `${METHOD}${PATH}${api-expires}` است. منظور از METHOD پروتکل HTTP می باشد، PATH آدرسی است که درخواست به آن فرستاده می شود و api-expires نشان دهنده زمان انقضا درخواست  هست و به صورت unix timestamp می باشد.

اگر درخواست شما شامل BODY نیز باشد، باید به صورت JSON OBJECT ، به string شما اضافه شود `${METHOD}${PATH}${api-expires}${JSON_BODY}`

مراحل ساخت کلید API:

در بخش امنیت، بعد از فعال سازی رمز یکبار مصرف، در زیر مجموعه “برنامه نویسان” روی “کلید API خود را بسازید” کلیک کنید.

ارتقا API ها و ساختار توکن‌ها

یک نام برای کلید API خود تعیین کنید.

رمز یکبار مصرف را وارد نمایید.

کلید API و کلید خصوصی شما ایجاد شده و می توانید آنها را در برنامه خود ذخیره نمایید.

همینطور در نمونه دستور CURL در پایین مشاهده می کنید، api-key , api-signature و api-expires در Header  درخواست شما قرار می گیرند.

دقت داشته باشید که درخواست شما بر اساس زمانی که در Api-expires ، در فرمت UNIX وارد می کنید، منقضی خواهد شد.

curl -X POST
-H “api-key: $API_KEY”
-H “api-signature: $API_SIGNATURE”
-H “api-expires: $API_EXPIRES”
“api_endpoint_here”

 

در صورت نیاز می توانید ویدیوی آموزشی مربوط به ساخت، استفاده از کلید API نسخه جدید را در اینجا مشاهده نمایید.

اکسیر