مستندات WEEX API: چگونه کار با API معاملاتی WEEX را آغاز کنیم

By: WEEX|07/10/2026 06:45:19
0
اشتراک‌گذاری
copy
امتیازدهی ما در گوگلامتیازدهی ما در گوگل

برای شروع کار با WEEX API، به دو چیز نیاز دارید: مستندات رسمی WEEX API و یک API Key که برای قابلیت‌های موردنظر شما پیکربندی شده باشد. WEEX منابع API را برای معاملات اسپات و قراردادهای آتی USDT-M ارائه می‌کند. این مستندات داده‌های بازار، قابلیت‌های حساب، عملیات معاملاتی، REST API و اتصال‌های WebSocket را پوشش می‌دهند.

برای دسترسی به داده‌های عمومی بازار، توسعه‌دهندگان می‌توانند بدون احراز هویت از endpointهای پشتیبانی‌شده استفاده کنند. قابلیت‌های خصوصی، از جمله مدیریت حساب و سفارش‌ها، به API Key و درخواست‌های احرازشده نیاز دارند.

مراحل راه‌اندازی ساده است: مستندات مرتبط WEEX API را انتخاب کنید، یک API Key بسازید، مجوزهای لازم را تنظیم کنید، از اطلاعات ورود محافظت کنید و برنامه خود را به endpoint مناسب API متصل کنید.

مستندات رسمی WEEX API را از کجا پیدا کنید؟

WEEX مستندات اختصاصی‌ای برای محصولات و رابط‌های پشتیبانی‌شده خود ارائه می‌کند. این مستندات هم‌زمان با تغییر قابلیت‌های API به‌روزرسانی می‌شوند و صفحه هر endpoint شامل نمونه درخواست‌ها و پاسخ‌ها برای یکپارچه‌سازی است. 

مستندات Spot V3 فرایند آماده‌سازی، دامنه‌های API، احراز هویت، داده‌های بازار، قابلیت‌های حساب، قابلیت‌های سفارش، اتصال‌های WebSocket، محدودیت‌های نرخ درخواست و دیگر الزامات فنی را پوشش می‌دهد.

WEEX APIها را به رابط‌های عمومی و خصوصی تقسیم می‌کند. APIهای عمومی می‌توانند بدون احراز هویت، اطلاعات پیکربندی و داده‌های بازار را دریافت کنند. APIهای خصوصی قابلیت‌هایی مانند مدیریت سفارش و حساب را پوشش می‌دهند و به درخواست‌های احرازشده نیاز دارند.

پیش از یکپارچه‌سازی، توسعه‌دهندگان باید مستندات محصولی را انتخاب کنند که قصد استفاده از آن را دارند؛ زیرا endpointها و الزامات فنی اسپات و معاملات آتی ممکن است متفاوت باشند.

مستندات WEEX API: چگونه کار با API معاملاتی WEEX را آغاز کنیم

چگونه یک WEEX API Key بسازید

برای استفاده از قابلیت‌های خصوصی WEEX API، ابتدا باید از طریق حساب WEEX خود یک API Key بسازید. طبق مستندات فعلی Spot V3، مراحل اصلی به این صورت است:

  1. از طریق پلتفرم وب وارد WEEX شوید.
  2. بخش مدیریت API را باز کنید و یک API Key جدید بسازید.
  3. مجوزهای موردنیاز برای یکپارچه‌سازی خود را تنظیم کنید.
  4. در صورت تناسب با پیکربندی شما، یک آدرس IP را متصل کنید.
  5. اطلاعات اعتبار API را که در این فرایند ایجاد یا پیکربندی شده‌اند، با امنیت ذخیره کنید.

در حال حاضر، هر حساب WEEX می‌تواند حداکثر ۱۰ گروه API Key بسازد. این امکان به کاربران اجازه می‌دهد برای برنامه‌ها یا پیکربندی‌های معاملاتی مختلف، API Keyهای جداگانه داشته باشند و برای همه اتصال‌ها به یک Key متکی نباشند.

هنگام ساخت API Key، سه مورد از اطلاعات ورود اهمیت دارند: APIKey کاربر API را برای احراز هویت مشخص می‌کند. SecretKey کلید خصوصی‌ای است که برای تولید امضای درخواست به کار می‌رود.

Passphrase را کاربر تعیین می‌کند و برای دسترسی احرازشده لازم است. اگر Passphrase گم شود، WEEX اعلام می‌کند که بازیابی آن امکان‌پذیر نیست و باید یک API Key جدید ساخته شود. این اطلاعات باید به‌صورت امن نگهداری شوند و نباید با دیگران به اشتراک گذاشته شوند.

چگونه مجوزهای WEEX API را پیکربندی کنید

مجوز پیش‌فرض یک WEEX Spot API Key تازه‌ساخته‌شده، فقط خواندنی (Read Only) است. این مجوز به Key اجازه می‌دهد بدون دسترسی به انجام عملیات معاملاتی اسپات، از قابلیت‌های جست‌وجوی پشتیبانی‌شده استفاده کند.

اگر برنامه‌ای باید سفارش‌های اسپات ثبت یا لغو کند، باید مجوز مربوط به Spot فعال شود.

بنابراین، مجوز مناسب به کاری بستگی دارد که برنامه باید انجام دهد. ابزاری که فقط برای پایش موجودی، بررسی سابقه معاملات یا تحلیل اطلاعات استفاده می‌شود، می‌تواند در حالت فقط خواندنی باقی بماند. برنامه‌ای که برای اجرای سفارش‌های اسپات طراحی شده، به مجوز معاملات Spot نیاز دارد.

WEEX همچنین به کاربران اجازه می‌دهد API Keyها را به آدرس‌های IP متصل کنند. مستندات رسمی هشدار می‌دهد که API Keyهای بدون محدودیت و بدون اتصال IP، خطر امنیتی بیشتری دارند و توصیه می‌کند هنگام ساخت Key، یک آدرس IP به آن متصل شود.

رویکردی کاربردی این است که هر یکپارچه‌سازی فقط مجوزهایی را داشته باشد که واقعاً به آن نیاز دارد، نه دسترسی‌های اضافه‌ای که برنامه از آن‌ها استفاده نخواهد کرد.

قیمت --

--
--
--

چگونه به WEEX REST API متصل شوید

پس از آماده‌شدن API Key و مجوزها، می‌توانید برنامه خود را به WEEX REST API متصل کنید. WEEX برای داده‌های بازار، اطلاعات حساب و عملیات معاملاتی پشتیبانی‌شده، endpointهای REST API ارائه می‌کند.

برای دریافت اطلاعات بازار می‌توان از endpointهای عمومی بدون احراز هویت استفاده کرد. endpointهای خصوصی، مانند قابلیت‌های حساب و سفارش، به احراز هویت با اطلاعات API شما نیاز دارند و باید از الزامات امضای مشخص‌شده در مستندات رسمی WEEX API پیروی کنند.

برای شروع، بهتر است پیش از استفاده از قابلیت‌های احرازشده، یک درخواست عمومی دریافت داده‌های بازار را آزمایش کنید. پس از برقراری اتصال، می‌توانید بر اساس مجوزهای فعال‌شده برای API Key خود از endpointهای خصوصی مناسب استفاده کنید.

از آنجا که endpointهای API و الزامات فنی ممکن است به‌روزرسانی شوند، هنگام پیکربندی یکپارچه‌سازی خود همیشه به تازه‌ترین مستندات WEEX API مراجعه کنید.

چگونه اتصال WEEX API خود را بررسی کنید

یک راه ساده برای آغاز یکپارچه‌سازی این است که پیش از افزودن قابلیت‌های معاملاتی پیچیده‌تر، مطمئن شوید برنامه می‌تواند با موفقیت با WEEX API ارتباط برقرار کند.

ابتدا می‌توان درخواست‌های API عمومی را آزمایش کرد، زیرا به احراز هویت نیاز ندارند. پس از برقراری اتصال پایه، می‌توان درخواست‌های احرازشده را متناسب با مجوزهای اختصاص‌یافته به API Key آزمایش کرد.

اگر یک درخواست احرازشده ناموفق باشد، ممکن است لازم باشد چند بخش از تنظیمات را بررسی کنید؛ از جمله اطلاعات اعتبار API، مجوزها، امضای درخواست، timestamp، دامنه API و محدودیت‌های IP.

WEEX برای درخواست‌های احرازشده استفاده از یک روش امضای استاندارد را الزامی می‌داند. طبق مستندات فعلی V3، timestamp درخواست بر حسب میلی‌ثانیه محاسبه می‌شود و اگر اختلاف آن با زمان سرور WEEX API بیش از ۳۰ ثانیه باشد، ممکن است درخواست رد شود. 

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

پیش از استفاده از WEEX API برای معامله چه مواردی را بررسی کنید؟

پیش از استفاده از WEEX API برای معامله، مجوزهای API Key خود را بررسی کنید و مطمئن شوید Key فقط به دسترسی‌های موردنیاز برنامه شما مجهز است. WEEX همچنین توصیه می‌کند API Keyها را به آدرس‌های IP مورداعتماد متصل کنید و از API Key، SecretKey و Passphrase خود محافظت کنید.

توسعه‌دهندگان باید محدودیت‌های نرخ درخواست فعلی API را نیز بررسی و خطاهای درخواست را به‌درستی مدیریت کنند. عبور از محدودیت‌های مربوطه ممکن است باعث ردشدن درخواست‌ها شود؛ بنابراین، سیستم‌های خودکار باید طوری طراحی شوند که در محدوده مشخص‌شده در مستندات رسمی باقی بمانند.

پیش از استفاده از API برای معاملات زنده، اتصال، احراز هویت، مجوزها و منطق سفارش‌گذاری را با دقت آزمایش کنید. برای اطلاع از تازه‌ترین الزامات امنیتی و محدودیت‌های نرخ درخواست، به مستندات فعلی WEEX API مراجعه کنید.

جمع‌بندی

برای شروع کار با WEEX API باید مستندات رسمی مناسب را انتخاب کنید، یک API Key بسازید، مجوزهای آن را پیکربندی کنید، از اطلاعات ورود محافظت کنید و برنامه را به endpoint مرتبط API متصل کنید.

توسعه‌دهندگان می‌توانند کار را با درخواست‌های عمومی API آغاز کنند و سپس به سراغ قابلیت‌های احرازشده حساب یا معاملات بروند. برای اطلاع از endpointهای فعلی، الزامات احراز هویت، مجوزها و محدودیت‌های نرخ درخواست، تازه‌ترین مستندات WEEX API باید مرجع فنی اصلی باشد.

پرسش‌های متداول

۱. مستندات رسمی WEEX API را از کجا پیدا کنم؟
WEEX مستندات اختصاصی‌ای ارائه می‌کند که محصولات API، endpointها، احراز هویت، اتصال‌های WebSocket، پارامترها و نمونه پاسخ‌ها را پوشش می‌دهد. توسعه‌دهندگان باید از تازه‌ترین نسخه استفاده کنند، زیرا قابلیت‌های API ممکن است به‌مرور به‌روزرسانی شوند.

۲. چگونه یک WEEX API Key بسازم؟
وارد پلتفرم وب WEEX شوید و برای ساخت و پیکربندی API Key، بخش مدیریت API را باز کنید. در حال حاضر، هر حساب می‌تواند حداکثر ۱۰ گروه API Key بسازد.

۳. پس از ساخت WEEX API Key باید چه اطلاعاتی را ذخیره کنم؟
APIKey، SecretKey و Passphrase را به‌صورت امن ذخیره کنید. Passphrase گم‌شده قابل بازیابی نیست؛ بنابراین، اگر آن را گم کنید باید یک API Key جدید بسازید.

۴. مجوزهای پیش‌فرض یک WEEX API Key جدید چیست؟
مجوز پیش‌فرض یک Spot API Key جدید، فقط خواندنی (Read Only) است. برای انجام عملیات معاملاتی اسپات، باید مجوز مربوط به معاملات Spot فعال شود.

۵. چرا درخواست WEEX API من کار نمی‌کند؟
از دلایل رایج می‌توان به اطلاعات اعتبار نادرست، مجوزهای ناکافی، خطاهای امضا، اختلاف timestamp، محدودیت‌های IP یا محدودیت‌های نرخ درخواست اشاره کرد. بر اساس خطایی که درخواست برمی‌گرداند، بخش مرتبط مستندات رسمی WEEX API را بررسی کنید.

این محتوا صرفاً برای اطلاع‌رسانی عمومی ارائه شده است و به‌منزله مشاوره مالی، سرمایه‌گذاری، حقوقی یا مالیاتی تلقی نمی‌شود. هرگونه رویداد، جایزه، کمپین آنلاین یا اطلاعات مرتبط که در اینجا ذکر شده است، نباید به‌عنوان توصیه، ترغیب یا دعوت به خرید، فروش، معامله یا هرگونه دادوستد دیگر دارایی‌های رمزارزی تلقی شود. دارایی‌های رمزارزی از نوسان بالایی برخوردار هستند و ممکن است منجر به زیان شوند. دسترسی به خدمات، محصولات و رویدادهای مرتبط با WEEX ممکن است بسته به منطقه جغرافیایی متفاوت باشد. اطمینان از اینکه استفاده شما از این خدمات با قوانین و مقررات محلی مطابقت دارد، بر عهده خود شماست.

ممکن است شما نیز علاقه‌مند باشید

رمزارزهای محبوب

جدیدترین مقالات

بیشتر
iconiconiconiconiconiconiconicon
پشتیبانی مشتری:@weikecs
همکاری تجاری:@weikecs
معاملات کمّی و بازارسازی:[email protected]
برنامه VIP:[email protected]