کلیدهای API کدهایی برای احراز هویت برنامه‌ها و وبسایت ها جهت ایجاد دسترسی ایمن و قابل اطمینان از طرف برنامه ها و پلتفرم ها صورت می‌گیرد. ای پی آی API ارز دیجیتال نیز یکی از فناوری‌های پیشرفته محبوب است که با استفاده از این فناوری در صرافی‌های ارز دیجیتال کاربرد فراوانی دارد و دنیای رمز ارزها را برای معامله گران و فعالان بازار رمز ارز بسیار جذاب‌تر کرده است. صرافی ارز دیجیتال والکس هم با بهره‌مندی از این فناوری توانسته امکانات زیادی در اختیار کاربران خود قرار دهد.
پلتفرم معاملاتی والکس یا همان صرافی والکس یکی از قدیمی ترین وبسایت های خرید و فروش ارزهای دیجیتال است که در مورد این فناوری پیشرفته و محبوب توانسته است با بهره مندی از این فناوری، امکانات زیادی را در اختیار کاربران خود قرار دهد. ما در این مقاله سعی داریم روش استفاده از API والکس را با هم بررسی کنیم.
نحوه استفاده از API والکس؛ انتخاب نام و روش ساخت API KEYS
روش استفاده از API والکس
انتخاب نام و روش ساخت API KEYS
هدف اصلی استفاده از API ارز دیجیتال در بازار رمز ارزها و صرافی‌های ارز دیجیتال این است که معامله‌گران بتوانند راحت‌تر، سریع‌تر و موفق‌تر به انجام معاملات ارزی خود بپردازند. آسان بودن نحوه استفاده از API والکس باعث می‌شود تا کاربران این اپلیکیشن به راحتی بتوانند از مزایای آن بهره‌مند شوند.
در واقع شما به عنوان یک کاربر می‌توانید در مدت زمانی کوتاه نحوه استفاده از API والکس را بیاموزید و با در اختیار داشتن اطلاعات دقیق بازار ارزهای دیجیتال و معاملات صورت گرفته در آن، معاملات خوبی انجام دهید.
ثبت نام در صرافی والکس
نحوه استفاده از API والکس چگونه است؟
اگر با مفهوم API ارز دیجیتال آشنا باشید، ممکن است در مرحله بعد این سؤال برای شما پیش بیاید که نحوه استفاده از API والکس چیست؟ همانطور که می‌دانید API در دنیای ارزهای دیجیتال مانند یک نامه‌رسان عمل می‌کند و فعالیت خود را در صرافی‌های ارز دیجیتال با هدف آسان کردن معاملات ارزی برای کاربران انجام می‌دهد. از مهم‌ترین مزایای استفاده از Api والکس این است که اطلاعات دقیقی درباره بازار رمز ارزها و معاملات انجام شده در آن در اختیار شما قرار می‌دهد. بدین ترتیب شما می‌توانید یک معامله رمز ارز حرفه‌ای و موفقیت‌آمیز داشته باشید.
حال که صحبت درباره نحوه استفاده از API والکس است خوب است به این نکته اشاره کنیم که دو مدل API به نام‌های خصوصی و عمومی وجود دارد. تفاوت این دو نیز در دریافت توکن (Token) است. به این صورت که در API عمومی نیازی به دریافت توکن و احراز هویت برای کاربران نیست اما در API خصوصی کاربران ابتدا باید یک توکن دریافت کنند.
نحوه استفاده از API والکس که یکی از بهترین ابزارهای معامله محسوب می‌شود، بسیار ساده و اصطلاحاً کاربر پسند است. زیرا تمام کدها از قبل آماده شده است و شما تنها باید آنها را وارد کنید. در واقع شما به هر اطلاعاتی که نیاز داشته باشید، می‌توانید کد مخصوص آن را در قسمت مستندات API پیدا کنید و با استفاده از آن، به آنها دسترسی داشته باشید. اطلاعاتی مثل: لیست سفارش‌های بازار و آخرین معاملات آن، ایجاد یا حذف شماره کارت، لیست شماره شباهای حساب، کیف پول ارز دیجیتال و…
نکته مهم دیگری که در بررسی نحوه استفاده از API والکس باید به آن بپردازیم، کلیدهای API یا API Keys است. اولین چیزی که هنگام استفاده از API در یک صرافی ارز دیجیتال نیاز دارید، همین کلیدهای API هستند که باید برای خودتان بسازید. روش ساخت آن در اپلیکیشن والکس بسیار ساده است که در ادامه به آن می‌پردازیم.
ساخت و مدیریت کلیدهای API
برای ساخت و مدیریت کلیدهای API همانطور که در سند API والکس نیز به آن اشاره شده است شما باید به بخش مدیریت API سایت والکس مراجعه کرده؛ و برای ساخت کلید جدید کافیست بر روی دکمهٔ «ساخت API» کلیک کنید.
در بخش ساخت API، لازم است که برای کلید جدید نامی منحصربه‌فرد و دلخواه انتخاب کنید. طبق داکیومنت api، این مدت زمان می‌تواند به دو ماه (۶۰ روز) یا یک ماه (۳۰ روز) تغییر کند و قابل تمدید نیست. بعد از گذشت زمان اعتبار، کلید به صورت خودکار منقضی خواهد شد و نیاز است تا کلید جدیدی ایجاد شود.
برای امنیت بیشتر در انتخاب مجوزهای دسترسی دقت کافی داشته و در صورت امکان فهرستی از IPهای مجاز که با استفاده از کلید می‌توانند به اندپوینت‌های شخصی دسترسی داشته باشند، وارد کنید. بدیهی‌ست که خالی گذاشتن لیست IPهای مجاز به معنای اعطای مجوز به تمام IPهاست.
تعیین مجوزهای لازم
در نحوه استفاده از API والکس، آگاهی داشتن از چگونگی تعیین مجوزهای لازم هنگام ساخت کلیدهای API هم خالی از لطف نیست. حالت پیش فرض برای کلیدهای API این گونه است که تمام آنها اجازه خواندن دارند. حال شما می‌توانید مجوزهای معامله رمزارز و برداشت را هم فعال کنید. اما نکته مهمی که وجود دارد این است که در صورت فعال کردن مجوز برداشت، باید IP های مجاز را در حساب خود وارد کنید تا امنیت معاملاتتان به خوبی حفظ شود.
وارد کردن IP های مجاز
نحوه استفاده از API والکس بسیار ساده است. شما فقط باید موفق به ساخت کلیدهای API خود شوید. در آخرین مرحله این کار شما باید احراز هویت دو مرحله‌ای را هم پشت سر بگذارید. بنابراین رمزهای یکبار مصرفی که به گوشی موبایل و ایمیلتان ارسال شده است را وارد کنید. نکته مهمی که در نحوه استفاده از API والکس و ساخت کلیدهای API وجود دارد این است که پس از اتمام این مراحل، شما فقط یک بار فرصت دارید تا کلید API خود را مشاهده و یادداشت کنید.
برای بررسی بیشتر این موارد و درک بهتر از نحوه عملکرد API در سایت والکس، به لندینگ API مراجعه کنید.
API والکس
استفاده از کلید API
برای ارسال درخواست به اندپوینت‌های محافظت‌شده بایستی، یک هدر X-API-Key به درخواست HTTP افزوده، و مقدار آن را برابر با کلیدی که در بخش قبل ایجاد کرده‌اید، قرار دهید.
جدول درخواست‌های API در والکس
| کاربرد | درخواست | |
|---|---|---|
| لیست بازارها | با این درخواست می‌توانید لیستی از بازارها و وضعیت آنها دریافت کنید. | GET https://api.wallex.ir/v1/markets |
| آمار جهانی رمزارزها | با این درخواست می‌توانید آخرین آمار جهانی رمزارزها را دریافت کنید. | GET https://api.wallex.ir/v1/currencies/stats |
| ثبت سفارش | با این درخواست می‌توانید سفارش جدیدی برای خرید/فروش رمزارز ثبت کنید. | POST https://api.wallex.ir/v1/account/orders |
| لیست سفارش‌های باز | با این درخواست می‌توانید لیست سفارش‌های باز (Order Book) هر بازار را دریافت کنید. | GET https://api.wallex.ir/v1/depth |
| لیست سفارش‌های باز تمام بازارها | با درخواست زیر می‌توانید لیست سفارش‌های باز (Order Book) تمام بازارها را یکجا دریافت کنید. | GET https://api.wallex.ir/v2/depth/all |
| لیست آخرین معاملات کاربر | با این درخواست می‌توانید لیستی از سفارش‌های فعال را دریافت کنید: | GET https://api.wallex.ir/v1/account/trades |
| لغو سفارش | با این درخواست می‌توانید یک سفارش فعال را لغو کنید: | DELETE https://api.wallex.ir/v1/account/orders |
| لیست آخرین معاملات | با درخواست زیر می‌توانید فهرستی از آخرین معاملات بازار والکس را دریافت کنید | GET https://api.wallex.ir/v1/trades |
| اطلاعات سفارش | با این درخواست می‌توانید اطلاعات یک سفارش ثبت شده را دریافت کنید. | GET https://api.wallex.ir/v1/account/orders/{clientOrderId} |
| کندل‌ها (آمار OHLC بازارها) | با این درخواست می‌توانید کندل‌های بازارهای والکس را در بازهٔ زمانی مشخص دریافت کنید. | GET https://api.wallex.ir/v1/udf/history |
| لیست سفارش‌های فعال کاربر | با این درخواست می‌توانید لیستی از سفارش‌های فعال را دریافت کنید. | GET https://api.wallex.ir/v1/account/openOrders |
لیست درخواست‌های API در صرافی والکس
لیست بازارها
با درخواست زیر می‌توانید لیستی از بازارها و وضعیت آنها دریافت کنید:
GET https://api.wallex.ir/v1/markets
آمار جهانی رمزارزها
با این درخواست می‌توانید آخرین آمار جهانی رمزارزها را دریافت کنید:
GET https://api.wallex.ir/v1/currencies/stats
لیست سفارش‌های باز
با درخواست زیر می‌توانید لیست سفارش‌های باز (Order Book) هر بازار را دریافت کنید:
GET https://api.wallex.ir/v1/depth
لیست سفارش‌های باز تمام بازارها
با درخواست زیر می‌توانید لیست سفارش‌های باز (Order Book) تمام بازارها را یکجا دریافت کنید:
GET https://api.wallex.ir/v2/depth/all
لیست آخرین معاملات
با درخواست زیر می‌توانید فهرستی از آخرین معاملات بازار والکس را دریافت کنید:
GET https://api.wallex.ir/v1/trades
کندل‌ها (آمار OHLC بازارها)
با این درخواست می‌توانید کندل‌های بازارهای والکس را در بازهٔ زمانی مشخص دریافت کنید:
GET https://api.wallex.ir/v1/udf/history
ثبت سفارش
با این درخواست می‌توانید سفارش جدیدی برای خرید/فروش رمزارز ثبت کنید:
POST https://api.wallex.ir/v1/account/orders
اطلاعات سفارش
با این درخواست می‌توانید اطلاعات یک سفارش ثبت شده را دریافت کنید:
GET https://api.wallex.ir/v1/account/orders/{clientOrderId}
لغو سفارش
با این درخواست می‌توانید یک سفارش فعال را لغو کنید:
DELETE https://api.wallex.ir/v1/account/orders
لیست سفارش‌های فعال کاربر
با این درخواست می‌توانید لیستی از سفارش‌های فعال را دریافت کنید:
GET https://api.wallex.ir/v1/account/openOrders
لیست آخرین معاملات کاربر
با این درخواست می‌توانید لیستی از سفارش‌های فعال را دریافت کنید:
GET https://api.wallex.ir/v1/account/trades
اتصال به وب‌سوکت
برای اتصال به سرویس وب‌سوکت باید از کلاینت socket.io (نسخهٔ v2.5.0، یا سازگار با آن) استفاده کنید.
برای دریافت هر یک از اطلاعاتی که در ادامه توضیحات آنها خواهد آمد، باید برروی کانال آن سابسکرایب کنید. برای این منظور پارامتر eventName را برابر subscribe تنظیم و آبجکتی را که مشخصات آن، بنا بر آنچه در ادامه گفته خواهد شد، مرتبط با نوع داده‌های دریافتی‌ست به عنوان پارامتر args ارسال کنید.
تفسیر داده‌های دریافتی مشابه آن چیزی‌ست که برای اندپوینت‌های مرتبط با هر کدام از این اطلاعات پیشتر گفته شده است.
سفارش‌های فعال
برای دریافت سفارش‌های فعال خرید و فروش برای هر یک از بازارها، باید به‌ترتیب برروی کانال‌های SYMBOL@buyDepth و SYMBOL@sellDepth سابسکرایب کنید.
معامله‌های انجام‌شده
برای دریافت سفارش‌های انجام‌شده برای هر یک از بازارها باید برروی کانال SYMBOL@trade سابسکرایب کنید.
اطلاعات زندهٔ بازار
برای دریافت بروزترین اطلاعات هر یک از بازارها باید برروی کانال SYMBOL@marketCap سابسکرایب کنید.
والکس و ویژگی API ارز دیجیتال
ما در این مقاله سعی کردیم تا شما را با مفهوم کلی API ارز دیجیتال آشنا کنیم و نحوه استفاده از API صرافی والکس را با یکدیگر بررسی کنیم.
منبع:
وبسایت صرافی والکس