توثيق WEEX API: كيفية البدء باستخدام واجهة التداول API من WEEX

يبدأ استخدام WEEX API بأمرين: وثائق WEEX API الرسمية ومفتاح API مُهيأ للوظائف التي تريد استخدامها. توفر WEEX موارد API للتداول الفوري والعقود الآجلة USDT-M، وتشمل الوثائق بيانات السوق ووظائف الحساب وعمليات التداول وREST API واتصالات WebSocket.

للوصول إلى بيانات السوق العامة، يمكن للمطورين استخدام نقاط النهاية المدعومة دون مصادقة. أما الوظائف الخاصة، بما فيها إدارة الحساب والطلبات، فتتطلب مفتاح API وطلبات مصادقًا عليها.

عملية الإعداد بسيطة: اختر وثائق WEEX API ذات الصلة، وأنشئ مفتاح API، واضبط الأذونات اللازمة، واحفظ بيانات الاعتماد بأمان، ثم اربط تطبيقك بنقطة نهاية API المناسبة.

أين تجد وثائق WEEX API الرسمية؟

توفر WEEX وثائق مخصصة تغطي منتجاتها وواجهاتها المدعومة. تُحدَّث الوثائق مع تغيّر ميزات API، وتتضمن صفحات نقاط النهاية الفردية أمثلة على الطلبات والاستجابات اللازمة للتكامل. 

بالنسبة إلى Spot V3، تغطي الوثائق خطوات التحضير ونطاقات API والمصادقة وبيانات السوق ووظائف الحساب ووظائف الطلبات واتصالات WebSocket وحدود معدل الطلبات والمتطلبات التقنية الأخرى.

تقسم WEEX واجهات API إلى عامة وخاصة. تتيح واجهات API العامة استرجاع الإعدادات وبيانات السوق دون مصادقة. أما واجهات API الخاصة فتغطي وظائف مثل إدارة الحساب والطلبات، وتتطلب طلبات مصادقًا عليها.

قبل إجراء التكامل، ينبغي للمطورين اختيار الوثائق الخاصة بالمنتج الذي يخططون لاستخدامه، إذ قد تختلف نقاط النهاية والمتطلبات التقنية بين التداول الفوري والعقود الآجلة.

كيفية إنشاء مفتاح WEEX API

لاستخدام وظائف WEEX API الخاصة، يجب أولًا إنشاء مفتاح API عبر حسابك على WEEX. ووفقًا لوثائق Spot V3 الحالية، تتضمن العملية الأساسية ما يلي:

1. سجّل الدخول إلى WEEX عبر منصة الويب.
2. افتح إدارة API وأنشئ مفتاح API جديدًا.
3. اضبط الأذونات التي يتطلبها التكامل.
4. اربط عنوان IP إذا كان ذلك مناسبًا لإعدادك.
5. احفظ بأمان بيانات اعتماد API التي أُنشئت أو ضُبطت أثناء العملية.

يمكن لكل حساب WEEX حاليًا إنشاء ما يصل إلى 10 مجموعات من مفاتيح API. ويتيح ذلك للمستخدمين الاحتفاظ بمفاتيح API منفصلة للتطبيقات أو إعدادات التداول المختلفة بدلًا من الاعتماد على مفتاح واحد لكل اتصال.

عند إنشاء مفتاح API، هناك ثلاث بيانات اعتماد مهمة: يحدد APIKey مستخدم API لأغراض المصادقة. أما SecretKey فهو المفتاح الخاص المستخدم لإنشاء توقيعات الطلبات.

يحدد المستخدم عبارة المرور Passphrase، وهي مطلوبة كجزء من الوصول المصادق عليه. وإذا فُقدت عبارة المرور، تذكر WEEX أنه لا يمكن استعادتها، ويجب إنشاء مفتاح API جديد. ينبغي حفظ بيانات الاعتماد هذه بأمان وعدم مشاركتها مع الآخرين.

كيفية ضبط أذونات WEEX API

يُنشأ مفتاح WEEX Spot API الجديد بصلاحية القراءة فقط Read Only افتراضيًا. ويتيح ذلك للمفتاح الوصول إلى وظائف الاستعلام المدعومة دون منحه صلاحية تنفيذ عمليات التداول الفوري.

إذا احتاج التطبيق إلى وضع طلبات التداول الفوري أو إلغائها، فيجب تفعيل صلاحية Spot المناسبة.

لذلك، تعتمد الصلاحية المناسبة على ما يحتاج التطبيق إلى تنفيذه. يمكن لأداة تُستخدم لمراقبة الأرصدة فقط أو مراجعة سجل التداول أو تحليل المعلومات أن تظل بصلاحية القراءة فقط Read Only. أما التطبيق المصمم لتنفيذ طلبات التداول الفوري فيتطلب صلاحية تداول Spot.

تتيح WEEX أيضًا للمستخدمين ربط مفاتيح API بعناوين IP. وتحذر الوثائق الرسمية من أن مفاتيح API غير المقيدة التي لا ترتبط بعنوان IP تنطوي على مخاطر أمنية إضافية، وتوصي بربط عنوان IP عند إنشاء المفتاح.

من الأساليب العملية منح كل تكامل الأذونات التي يحتاج إليها فعلًا فقط، بدلًا من تفعيل صلاحيات إضافية لن يستخدمها التطبيق.

كيفية الاتصال بـ WEEX REST API

بعد تجهيز مفتاح API وأذوناته، يمكنك ربط تطبيقك بـ WEEX REST API. توفر WEEX نقاط نهاية REST API لبيانات السوق ومعلومات الحساب وعمليات التداول المدعومة.

يمكن استخدام نقاط النهاية العامة لاسترجاع معلومات السوق دون مصادقة. أما نقاط النهاية الخاصة، مثل وظائف الحساب والطلبات، فتتطلب المصادقة باستخدام بيانات اعتماد API، ويجب أن تلتزم بمتطلبات التوقيع الواردة في وثائق WEEX API الرسمية.

من الأفضل البدء باختبار طلب عام لبيانات السوق قبل الانتقال إلى الوظائف المصادق عليها. وبعد نجاح الاتصال، يمكنك استخدام نقاط النهاية الخاصة المناسبة وفقًا للأذونات المفعّلة لمفتاح API.

نظرًا إلى احتمال تحديث نقاط نهاية API والمتطلبات التقنية، احرص دائمًا على الرجوع إلى أحدث وثائق WEEX API عند إعداد التكامل.

كيفية التحقق من اتصال WEEX API

من الطرق البسيطة لبدء التكامل التأكد من قدرة التطبيق على الاتصال بنجاح بـ WEEX API قبل إضافة وظائف تداول أكثر تعقيدًا.

يمكن البدء بطلبات API العامة لأنها لا تتطلب مصادقة. وبعد نجاح الاتصال الأساسي، يمكن اختبار الطلبات المصادق عليها وفقًا للأذونات المحددة لمفتاح API.

إذا فشل طلب مصادق عليه، فقد يلزم التحقق من عدة عناصر في الإعداد، منها بيانات اعتماد API والأذونات وتوقيع الطلب والطابع الزمني ونطاق API وقيود IP.

تتطلب WEEX استخدام طريقة توقيع موحدة في الطلبات المصادق عليها. ووفقًا لوثائق V3 الحالية، يُقاس الطابع الزمني للطلب بالمللي ثانية، وقد يُرفض الطلب إذا تجاوز الفرق بين طابعه الزمني ووقت خادم WEEX API 30 ثانية. 

يسهّل اختبار الاتصال خطوة بخطوة تحديد ما إذا كانت المشكلة ناتجة عن الاتصال أو المصادقة أو الأذونات أو الطلب نفسه.

ما الذي ينبغي التحقق منه قبل استخدام WEEX API للتداول؟

قبل استخدام WEEX API للتداول، راجع أذونات مفتاح API وتأكد من أنه لا يملك سوى الصلاحيات التي يحتاج إليها تطبيقك. وتوصي WEEX أيضًا بربط مفاتيح API بعناوين IP موثوقة والحفاظ على أمان مفتاح API وSecretKey وعبارة المرور Passphrase.

ينبغي للمطورين أيضًا التحقق من حدود معدل الطلبات الحالية ومعالجة أخطاء الطلبات على النحو الصحيح. قد يؤدي تجاوز الحدود المطبقة إلى رفض الطلبات، لذا ينبغي تصميم الأنظمة المؤتمتة بحيث تلتزم بالحدود المحددة في الوثائق الرسمية.

قبل استخدام API للتداول الفعلي، اختبر الاتصال والمصادقة والأذونات ومنطق الطلبات بعناية. للاطلاع على أحدث متطلبات الأمان وحدود معدل الطلبات، راجع وثائق WEEX API الحالية.

الخلاصة

يتضمن البدء باستخدام WEEX API اختيار الوثائق الرسمية المناسبة، وإنشاء مفتاح API، وضبط أذوناته، وحماية بيانات الاعتماد، وربط التطبيق بنقطة نهاية API ذات الصلة.

يمكن للمطورين البدء بطلبات API العامة قبل الانتقال إلى وظائف الحساب أو التداول التي تتطلب المصادقة. وتظل أحدث وثائق WEEX API المرجع التقني الأساسي لنقاط النهاية الحالية ومتطلبات المصادقة والأذونات وحدود معدل الطلبات.

الأسئلة الشائعة

1. أين أجد وثائق WEEX API الرسمية؟
توفر WEEX وثائق مخصصة تغطي منتجات API ونقاط النهاية والمصادقة واتصالات WebSocket والمعلمات وأمثلة الاستجابات. ينبغي للمطورين استخدام أحدث إصدار، لأن ميزات API قد تتغير بمرور الوقت.

2. كيف أنشئ مفتاح WEEX API؟
سجّل الدخول إلى منصة WEEX على الويب وافتح إدارة API لإنشاء مفتاح API وضبط إعداداته. يمكن لكل حساب حاليًا إنشاء ما يصل إلى 10 مجموعات من مفاتيح API.

3. ما المعلومات التي ينبغي حفظها بعد إنشاء مفتاح WEEX API؟
احفظ APIKey وSecretKey وعبارة المرور Passphrase بأمان. لا يمكن استعادة عبارة المرور المفقودة، لذا يجب إنشاء مفتاح API جديد إذا فُقدت.

4. ما الأذونات التي يمتلكها مفتاح WEEX API الجديد؟
يكون مفتاح Spot API الجديد مضبوطًا افتراضيًا على القراءة فقط Read Only. ولتنفيذ عمليات التداول الفوري، يجب تفعيل صلاحية تداول Spot المناسبة.

5. لماذا لا يعمل طلب WEEX API؟
تشمل الأسباب الشائعة بيانات الاعتماد غير الصحيحة أو عدم كفاية الأذونات أو أخطاء التوقيع أو اختلاف الطابع الزمني أو قيود IP أو حدود معدل الطلبات. راجع القسم المناسب في وثائق WEEX API الرسمية استنادًا إلى الخطأ الذي يعيده الطلب.