API الخاص

يوفر Trademen أيضًا واجهات برمجة تطبيقات HTTP خاصة تتيح الوصول للقراءة / الكتابة إلى حسابك الخاص باستخدام رمز الوصول الشخصي للوظائف التالية…

Register

تسجيل مستخدم جديد. طريقة POST المطلوبة وطلب بيانات النشر هي "first_name", "last_name", "email", "username", "password", "password_confirmation", "check_agreement". في حالة نجاحها ، ستعيد الطريقة تفاصيل ملف تعريف المستخدم ورمز الوصول الشخصي.

تسجيل نقطة النهاية: https://yourdomain.com/api/register

حقل وصف
first_name مطلوب - تعيين المستخدم first name
last_name مطلوب - تعيين المستخدم last name
email مطلوب - تعيين المستخدم email
username مطلوب - تعيين المستخدم username
password مطلوب - تعيين المستخدم password
password_confirmation مطلوب - تأكيد المستخدم password
check_agreement مطلوب - تحقق من شروط وسياسة التسجيل
نموذج طلب تسجيل:
 curl -v -X POST https://yourdomain.com/api/register \ -H "Content-Type: application/json" \ -d '{ "first_name": "Jhon", "last_name": "Doe", "email": "[email protected]", "username": "jhondoe", "password": "123456789", "password_confirmation": "123456789", "check_agreement": 1 }' 
Sوافرة سجل الرد الناجح: كود الحالة - 200
 { "success": true, "message": "The registration was successful. Please check your email to verify your account.", "data": { "user": { "email": "[email protected]", "username": "jhondoe", "referral_code": "fcdd3595-6ebe-4668-a65b-6444344eae1a", "assigned_role": "user", "id": "c0add1c9-bede-4224-ab5c-adcf79b0cb66", "updated_at": "2020-11-12T09:13:38.000000Z", "created_at": "2020-11-12T09:13:38.000000Z", "profile": { "id": "d2354e68-858c-4353-96ed-84cb22fa5af2", "user_id": "c0add1c9-bede-4224-ab5c-adcf79b0cb66", "first_name": "Jhon", "last_name": "Doe", "address": null, "phone": null, "created_at": "2020-11-12T09:13:38.000000Z", "updated_at": "2020-11-12T09:13:38.000000Z" } }, "access_token": "1|5mao11TRVlzCqF3JVAlPAw7aEJWfKUd2UjVjcqfC" } } 
نموذج استجابة خطأ التسجيل: كود الحالة - 400
 {"success": false,"message": "Failed to register."}

تسجيل الدخول

يرسل طلب تسجيل دخول المستخدم. طريقة POST المطلوبة وطلب بيانات النشر هي "username", "password". إذا نجحت ، ستعيد الطريقة رمز الوصول الشخصي.

نقطة نهاية تسجيل الدخول: https://yourdomain.com/api/login

حقل وصف
username مطلوب - تعيين المستخدم username
password مطلوب - تعيين المستخدم password
نموذج طلب تسجيل الدخول:
 curl -v -X POST https://yourdomain.com/api/login \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "username": "jhondoe", "password": "123456789" }' 
نموذج استجابة ناجحة لتسجيل الدخول: كود الحالة - 200
 { "success": true, "message": "Login is successful.", "data": { "access_token": "2|qL8HUXM4uz0hLS0GHjGeB1bsAQPDmUSfOzDFQu83" } }
نموذج للرد على خطأ تسجيل الدخول: كود الحالة - 400
 { "success": false, "message": "Failed to login." }

تعيين كلمة مرور جديدة

يرسل طلب تعيين كلمة مرور جديدة. طريقة POST المطلوبة وطلب بيانات النشر هي "new_password", "password_confirmation", "verification_code", "email", "verifier_hash_code". إذا نجحت ، ستُرجع الطريقة رمز تجزئة المحقق.

قم بتعيين نقطة نهاية كلمة المرور الجديدة: https://yourdomain.com/api/forget-password/set-password

حقل وصف
new_password مطلوب - تعيين المستخدم new password
password_confirmation مطلوب - تأكيد المستخدم password
verification_code مطلوب - رمز التحقق الذي قدمه المستخدم والذي تم إرساله إلى البريد الإلكتروني المسجل للمستخدم
email مطلوب - تعيين المستخدم registered email
verifier_hash_code مطلوب - قم بتوفير رمز تجزئة المدقق من "احصل على طلب نسيت كلمة المرور"
نموذج طلب تعيين كلمة مرور جديدة:
 curl -v -X POST https://yourdomain.com/api/forget-password \ -H "Content-Type: application/json" \ -d '{ "new_password" : "123456789", "password_confirmation" : "123456789", "verification_code" : "123456", "email" : "[email protected]", "verifier_hash_code" : "y$Hy5KxTxLOREsrvjZnhBut.hcrg9w2EaxZZVIJTRsM9fO5uhw.d97y" }' 
نموذج لتعيين كلمة مرور جديدة استجابة ناجحة: كود الحالة - 200
 { "success": true, "message": "New password is updated. Please login your account." }
نموذج للاستجابة لخطأ كلمة المرور الجديدة: كود الحالة - 400
 { "success": false, "message": "The verifier has code is invalid." }

احصل على رمز التحقق من البريد الإلكتروني

يرسل طلب التحقق من البريد الإلكتروني للمستخدم. طريقة POST المطلوبة وطلب بيانات النشر هي "email". إذا نجحت ، ستُرجع الطريقة رمز تجزئة المحقق.

احصل على رابط التحقق من البريد الإلكتروني / نقطة نهاية الرمز: https://yourdomain.com/api/verification/email

حقل وصف
email مطلوب - تعيين المستخدم email
نموذج الحصول على رابط / طلب رمز التحقق من البريد الإلكتروني:
 curl -v -X POST https://yourdomain.com/api/verification/email \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]" }' 
نموذج الحصول على رابط التحقق من البريد الإلكتروني / استجابة رمز ناجحة: كود الحالة - 200
 { "success": true, "message": "Email verification link is sent successfully.", "data": { "verifier_hash_code": "y$yh6b9vUFTi1B4Jywdc/YbuYMWQs.Wkl.STSikyt6ZNQYnMGIBndbG", "email": "[email protected]" } }
نموذج الحصول على رابط التحقق من البريد الإلكتروني / استجابة خطأ الرمز: كود الحالة - 400
 { "success": false, "message": "The given email address is already verified." }

التحقق من رمز التحقق من البريد الإلكتروني

يرسل طلب التحقق من الرمز المرسل إلى البريد الإلكتروني للمستخدم. طريقة POST المطلوبة وطلب بيانات النشر هي "البريد الإلكتروني" ، "verifier_hash_code" ، "رمز التحقق". في حالة نجاحها ، ستعرض الطريقة رمز تجزئة لأداة التحقق.

تحقق من نقطة نهاية رمز التحقق من البريد الإلكتروني: https://yourdomain.com/api/verification/verify-email-code

حقل الوصف
بريد إلكتروني مطلوب - تعيين البريد الإلكتروني للمستخدم
verifier_hash_code مطلوب - قدم رمز تجزئة للتحقق من استجابة "الحصول على طلب التحقق من البريد الإلكتروني"
رمز التحقق مطلوب - رمز التحقق الذي قدمه المستخدم والذي تم إرساله إلى البريد الإلكتروني المسجل للمستخدم
نموذج رابط / طلب رمز التحقق من البريد الإلكتروني:
 curl -v -X POST https://yourdomain.com/api/verification/verify-email-code \ -H "Content-Type: application / json" \ -d '{ "email": "[email protected]"} "
نموذج استجابة رمز التحقق من البريد الإلكتروني بنجاح: كود الحالة - 200
 {"success": true، "message": "تم التحقق من حسابك بنجاح." }
نموذج استجابة خطأ رمز التحقق من البريد الإلكتروني: كود الحالة - 400
 {"success": false، "message": "المدقق لديه رمز غير صالح." }

الحصول على ملف تعريف المستخدم

يرسل طلبًا للحصول على تفاصيل ملف تعريف المستخدم. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. في حالة نجاحها ، ستعيد الطريقة تفاصيل الملف الشخصي.

الحصول على نقطة نهاية تفاصيل الملف الشخصي: https://yourdomain.com/api/user/profile/show

نموذج طلب تفاصيل ملف التعريف:
 curl -v -X POST https://yourdomain.com/api/user/profile/show \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز الوصول "
نموذج لاستجابة الملف الشخصي: رمز الحالة - 200
 {"success": true، "data": {"user": {"id": "c0add1c9-bede-4224-ab5c-adcf79b0cb66"، "assign_role": "user" ، "مُعرّف_إحالة": فارغ ، "رمز_إحالة": "fcdd3595-6ebe-4668-a65b-6444344eae1a" ، "اسم المستخدم": "jhondoe" ، "البريد الإلكتروني": "[email protected]" ، "الصورة الرمزية": فارغ ، " google2fa_secret ": null،" is_id_verified ": 0،" is_email_verified ": 0،" is_financial_active ": 1،" is_accessible_under_maintenance ": 0،" is_super_admin ": 0،" status ":" active "،" created_by ": null،" created_at ":" 2020-11-12T09: 13: 38.000000Z "،" updated_at ":" 2020-11-12T09: 13: 38.000000Z "،" التفضيل ": null،" profile ": {" id ":" d2354e68 -858c-4353-96ed-84cb22fa5af2 "،" user_id ":" c0add1c9-bede-4224-ab5c-adcf79b0cb66 "،" first_name ":" Jhon "،" last_name ":" Doe "،" address ": null،" phone ": null،" created_at ":" 2020-11-12T09: 13: 38.000000Z "،" updated_at ":" 2020-11-12T09: 13: 38.000000Z "}}}}
نموذج لاستجابة خطأ الملف الشخصي: كود الحالة - 400
 {"message": "غير مصدق." }

تحديث ملف تعريف المستخدم

يرسل طلبًا لتحديث تفاصيل ملف تعريف المستخدم. طريقة PUT المطلوبة مع Bearer / Access-Token في طلب HEADER وبيانات النموذج هي "first_name" و "last_name" و "address". إذا نجحت ، ستعيد الطريقة رسالة النجاح.

تحديث نقطة نهاية تفاصيل الملف الشخصي: https://yourdomain.com/api/user/profile/update

حقل الوصف
الاسم_الأول مطلوب - حدد الاسم الأول للمستخدم
last_name مطلوب - حدد الاسم الأخير للمستخدم
العنوان اختياري - تعيين عنوان المستخدم
نموذج طلب تفاصيل ملف تعريف تحديث:
 curl -v -X PUT https://yourdomain.com/api/user/profile/update \ -H "نوع المحتوى: application / json" \ -H "التفويض: الحامل رمز الوصول \ -d '{"first_name": "Jhon"، "last_name": "Doe"،}' 
نموذج لاستجابة الملف الشخصي: رمز الحالة - 200
 {"success": true، "message": "تم تحديث الملف الشخصي بنجاح." }
نموذج لاستجابة خطأ الملف الشخصي لتحديث: كود الحالة - 401
 {"message": "غير مصدق." }

تغيير الصورة الرمزية للمستخدم

يرسل طلبًا لتحديث تفاصيل ملف تعريف المستخدم. طريقة POST المطلوبة مع Bearer / Access-Token في طلب HEADER وبيانات النموذج هي "avatar". في حالة نجاحها ، ستعرض الطريقة رسالة النجاح وعنوان url المحدث للصورة الرمزية.

تغيير نقطة نهاية الصورة الرمزية للملف الشخصي: https://yourdomain.com/api/user/profile/avatar/update

حقل الوصف
الصورة الرمزية مطلوب - حدد الاسم الأول للمستخدم
نموذج طلب صورة شخصية لتغيير الملف الشخصي:
 curl -v -X POST https://yourdomain.com/api/user/profile/avatar/update \ -H "Content-Type: application / json" \ -H "التفويض : رمز وصول الحامل \ -d '{"avatar": "file"}' 
نموذج لاستجابة الصورة الرمزية لملف تعريف التغيير: رمز الحالة - 200
 {"success": true، "message": "تم تحميل الصورة الرمزية بنجاح."، "data": {"avatar": "urlOfUpdatedAvatar"}}
نموذج لاستجابة خطأ الصورة الرمزية لتغيير الملف الشخصي: رمز الحالة - 400
 {"success": false، "message": "فشل تحميل الصورة الرمزية." }

تغيير كلمة المرور

يرسل طلبًا لتغيير كلمة مرور المستخدم. طريقة PUT المطلوبة مع Bearer / Access-Token في طلب HEADER وبيانات النموذج هي "password" ، "new_password" ، "new_password_confirmation". إذا نجحت ، ستعيد الطريقة رسالة النجاح.

تغيير نقطة نهاية كلمة المرور: https://yourdomain.com/api/user/password/update

حقل الوصف
كلمة المرور مطلوب - تعيين كلمة المرور القديمة للمستخدم
new_password مطلوب - تعيين كلمة مرور المستخدم الجديدة
تأكيد new_password_confirmation مطلوب - تأكيد كلمة المرور الجديدة
نموذج طلب تغيير كلمة المرور:
 curl -v -X PUT https://yourdomain.com/api/user/password/update \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز الوصول \ -d '{"password": "123456789"، "new_password": "123456789"، "new_password_confirmation": "123456789"}' 
نموذج استجابة تغيير كلمة المرور: رمز الحالة - 200
 {"success": true، "message": "تم تغيير كلمة المرور بنجاح." }
نموذج استجابة خطأ تغيير كلمة المرور: كود الحالة - 400
 {"success": false، "message": "فشل تغيير كلمة المرور." }

الحصول على تفضيلات الملف الشخصي

يرسل طلبًا للحصول على تفضيلات الملف الشخصي. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. في حالة نجاحها ، ستعيد الطريقة تفاصيل تفضيلات الملف الشخصي.

الحصول على نقطة نهاية التفضيل: https://yourdomain.com/api/user/password/update

نموذج طلب تفضيل الملف الشخصي:
 curl -v -X احصل على https://yourdomain.com/api/user/preference/show \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز الوصول 
نموذج الحصول على الأفضلية استجابة ناجحة: كود الحالة - 200
 {"success": true، "data": {"preference": {"user_id": "c0add1c9-bede-4224-ab5c-adcf79b0cb66"، "default_language": "ar" ، "default_coin_pair": فارغ ، "id": "82d30318-fa9c-42ad-a992-afa87337c324"}}}
نموذج استجابة أخطاء الحصول على التفضيل: رمز الحالة - 400
 {"message": "غير مصدق." }

تحديث تفضيلات الملف الشخصي

يرسل طلبًا لتحديث تفضيلات المستخدم. طريقة PUT المطلوبة مع Bearer / Access-Token في طلب HEADER وبيانات النموذج هي "display_language" و "default_coin_pair". إذا نجحت ، ستعيد الطريقة رسالة النجاح.

تحديث نقطة نهاية التفضيل: https://yourdomain.com/api/user/preference/update

حقل الوصف
display_language اختياري - حدد لغة المستخدم المفضلة.
default_coin_pair اختياري - حدد زوج العملات المفضل للمستخدم.
نموذج طلب تفضيل التحديث:
 curl -v -X PUT https://yourdomain.com/api/user/preference/update \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز الوصول \ -d '{"display_language": "en"، "default_coin_pair": "BTC_USD"}' 
نموذج استجابة تفضيل التحديث: كود الحالة - 200
 {"success": true، "message": "تم تحديث التفضيل بنجاح." }
نموذج استجابة خطأ في تفضيلات التحديث: كود الحالة - 400
 {"success": false، "message": "فشل تحديث التفضيل." }

التحقق من KYC

يرسل طلبًا لإرسال مستند (مستندات) التحقق من "اعرف عميلك". طريقة POST المطلوبة مع Bearer / Access-Token في طلب HEADER وبيانات النموذج هي "id_type" و "id_card_front" و "id_card_back" (اختياري إذا كان نوع المعرف هو جواز السفر). إذا نجحت ، ستعيد الطريقة رسالة النجاح.

نقطة نهاية التحقق من KYC: https://yourdomain.com/api/user/kyc-verifications

حقل الوصف
id_type مطلوب - عيّن نوع التحقق من الهوية مما يلي - "national_id" ، "driving_license" ، "جواز السفر".
id_card_front مطلوب - الصورة الأمامية للمعرف المعيّن.
id_card_back اختياري إذا كان نوع المعرف هو جواز السفر - الصورة الخلفية للمعرف.
نموذج طلب التحقق من KYC:
 curl -v -X POST https://yourdomain.com/api/user/kyc-verifications \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز الوصول \ -d '{"id_type": "national_id"، "id_card_front": "image ..."، "id_card_back": "image ..."،}' 
نموذج لاستجابة التحقق من KYC لتحديث: كود الحالة - 200
 {"success": true، "message": "تم تحميل المعرف بنجاح." }
نموذج استجابة خطأ التحقق من KYC: رمز الحالة - 400
 {"success": false، "message": "فشل تحميل المعرف." }

الحصول على تذاكر

يرسل طلبًا للحصول على تذاكر المستخدم. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. في حالة نجاحها ، ستعيد الطريقة تفاصيل التذاكر.

الحصول على نقطة نهاية التذاكر: https://yourdomain.com/api/user/tickets

نموذج طلب الحصول على تذاكر:
 curl -v -X احصل على https://yourdomain.com/api/user/tickets \ -H "Content-Type: application / json" \ -H "التفويض: وصول الحامل- رمز 
نموذج استجابة الحصول على التذاكر: رمز الحالة - 200
 {"success": true، "data": {"Tickets": {"current_page": 1، "data": []، "first_page_url": "http: // trademen .local / api / user / Tickets؟ page=1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: //trademen.local/api/user/tickets؟ page=1 " "الروابط": [{"url": null، "label": "& laquo؛ Previous"، "active": false}، {"url": "http: //trademen.local/api/user/tickets؟ صفح= 1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" Next & raquo؛ "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/tickets "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total ": 0}}}
نموذج للاستجابة لأخطاء الحصول على التذاكر: رمز الحالة - 400
 {"message": "غير مصدق." }

الحصول على تفاصيل التذكرة

يرسل طلبًا للحصول على تفاصيل التذكرة الفردية للمستخدم. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. في حالة نجاحها ، ستعيد الطريقة تفاصيل التذكرة الفردية.

الحصول على نقطة نهاية تفاصيل التذكرة: https://yourdomain.com/api/user/tickets/{ticketID}/show

نموذج طلب تفاصيل الحصول على تذكرة:
 curl -v -X احصل على https://yourdomain.com/api/user/tickets/c0add1c9-bede-4224-ab5c-adcf79b0cb66/show \ -H "نوع المحتوى: تطبيق / json "\ -H" التفويض: رمز وصول لحامله 
نموذج لاستجابة تفاصيل الحصول على تذكرة: رمز الحالة - 200
 {"success": true، "data": {"Tickets": {"current_page": 1، "data": []، "first_page_url": "http: // trademen .local / api / user / Tickets؟ page=1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: //trademen.local/api/user/tickets؟ page=1 " "الروابط": [{"url": null، "label": "& laquo؛ Previous"، "active": false}، {"url": "http: //trademen.local/api/user/tickets؟ صفح= 1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" Next & raquo؛ "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/tickets "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total ": 0}}}
نموذج لاستجابة خطأ تفاصيل الحصول على تذكرة: رمز الحالة - 400
 {"message": "غير مصدق." }

إرسال تذكرة

يرسل طلبًا لوضع بطاقة دعم. طريقة POST المطلوبة مع Bearer / Access-Token في طلب HEADER وبيانات النموذج هي "title" و "content" و "previous_id" و "attachment". في حالة نجاحها ، ستعيد الطريقة تفاصيل التذكرة الفردية.

حقل الوصف
العنوان مطلوب - قم بتعيين عنوان التذكرة.
معرف السابق اختياري - تعيين المعرف المرجعي السابق للتذكرة.
مرفق اختياري - تعيين صورة مرفق سابق للبطاقة.

إرسال نقطة نهاية تذكرة: https://yourdomain.com/api/user/tickets

نموذج إرسال طلب تذكرة:
 curl -v -X POST https://yourdomain.com/api/user/tickets \ -H "Content-Type: application / json" \ -H "التفويض: وصول الحامل- الرمز \ -d '{"title": "عنوان التذكرة هنا."، "content": "Ticket Content"، "previous_id": "c0add1c9-bede-4224-ab5c-adcf79b0cb66"، "attachment": "يتم نقل الملفات هنا ... "}" 
نموذج إرسال استجابة تذكرة: كود الحالة - 200
 {"success": true، "message": "تم إنشاء التذكرة بنجاح."، "data": {"تذكرة": {"user_id": "c0add1c9-bede-4224 -ab5c-adcf79b0cb66 "،" title ":" عنوان التذكرة يذهب هنا "،" content ":" Ticket Content Goes Here. "،" id ":" 9e13143a-0e6c-4251-8d03-f8fc24372be1 "،" updated_at ":" 2020-11-15T05: 15: 57.000000Z "،" created_at ":" 2020-11-15T05: 15: 57.000000Z "}}}
نموذج الرد على خطأ إرسال التذاكر: كود الحالة - 400
 {"success": false، "message": "فشل إنشاء التذكرة." }

تعليق على التذكرة

يرسل طلبًا لوضع تعليق على بطاقة الدعم. طريقة POST المطلوبة مع Bearer / Access-Token في طلب HEADER ومعلمة url هي معرف التذكرة وبيانات النموذج هي "محتوى" و "مرفق" (اختياري). إذا نجحت ، ستعيد الطريقة رسالة النجاح.

تعليق على نقطة نهاية تذكرة: https://yourdomain.com/api/user/tickets/{ticketID}/comment

حقل الوصف
محتوى مطلوب - قم بتعيين تعليق للتذكرة.
مرفق اختياري - تحميل صورة المرفق.
نموذج تعليق على طلب التذكرة:
 curl -v -X POST https://yourdomain.com/api/user/tickets/c0add1c9-bede-4224-ab5c-adcf79b0cb66/comment \ -H "نوع المحتوى: تطبيق / json "\ -H" التخويل: Bearer Access Token \ -d '{"content": "محتوى التعليق هنا .."، "attachment": "ملف الصورة ينتقل هنا .."،}' 
نموذج تعليق على استجابة التذكرة: رمز الحالة - 200
 {"success": true، "message": "تم إنشاء الرسالة بنجاح." }
نموذج تعليق على الاستجابة لأخطاء التذاكر: رمز الحالة - 400
 {"success": false، "message": "فشل وضع التعليق." }

إغلاق تذكرة

يرسل طلبًا لإغلاق بطاقة دعم. طريقة PUT المطلوبة مع Bearer / Access-Token في طلب HEADER ومعلمة url هي معرف التذكرة. إذا نجحت ، ستعيد الطريقة رسالة النجاح.

أغلق نقطة نهاية تذكرة: https://yourdomain.com/api/user/tickets/{ticketID}/close

نموذج إرسال طلب تذكرة:
 curl -v -X PUT https://yourdomain.com/api/user/tickets/c0add1c9-bede-4224-ab5c-adcf79b0cb66/close \ -H "نوع المحتوى: تطبيق / json "\ -H" التفويض: رمز وصول لحامله 
نموذج إرسال استجابة تذكرة: كود الحالة - 200
 {"success": true، "message": "تم إغلاق التذكرة بنجاح." }
نموذج الرد على خطأ إرسال التذاكر: كود الحالة - 400
 {"success": false، "message": "لم يتم العثور على البيانات ذات الصلة." }

تنزيل مرفق تعليق

يرسل طلبًا لتنزيل مرفق تعليق لتذكرة دعم. طريقة GET المطلوبة مع Bearer / Access-Token في طلب HEADER ومعلمة url هي معرف التذكرة واسم الملف. إذا نجحت ، فإن الطريقة ستعيد ملف المرفق.

تنزيل نقطة نهاية مرفق التعليق: https://yourdomain.com/api/user/tickets/{ticketID}/download-attachment/{fileName}

نموذج طلب تنزيل مرفق تعليق:
 curl -v -X احصل على https://yourdomain.com/api/user/tickets/c0add1c9-bede-4224-ab5c-adcf79b0cb66/download-attachment/c0add1c9-bede-4224- ab5c-adcf79b0cb66 \ -H "نوع المحتوى: application / json" \ -H "التفويض: رمز وصول الحامل 
تنزيل استجابة مرفق التعليق: STATUS CODE - 200
نموذج الرد على خطأ إرسال التذاكر: كود الحالة - 400

الحصول على محافظ

يرسل طلبًا للحصول على تفاصيل محافظ المستخدم. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. في حالة نجاحها ، ستعيد الطريقة تفاصيل المحافظ.

الحصول على نقطة نهاية المحافظ: https://yourdomain.com/api/user/wallets

نموذج طلب الحصول على محافظ:
 curl -v -X احصل على https://yourdomain.com/api/user/wallets \ -H "Content-Type: application / json" \ -H "التفويض: وصول الحامل- رمز 
نموذج استجابة تفاصيل الحصول على المحافظ: رمز الحالة - 200
 {"success": true، "data": {"current_page": 1، "data": [{"id": "8ac8dbee-666f-42bf-bb56-d4ff9276434d"، "user_id": "c0add1c9-bede-4224-ab5c-adcf79b0cb66"، "الرمز": "BTC"، "Primary_balance": "0.00000000"، "address": null، "passphrase": null، "is_system_wallet": false، "is_active": صحيح ، "created_at": "2020-11-15T10: 35: 46.000000Z"، "updated_at": "2020-11-15T10: 35: 46.000000Z"، "on_order_balance": null، "coin": {"الرمز": "BTC" ، "الاسم": "Bitcoin" ، "icon": null}} ، {"id": "15111092-39bb-49f8-944a-6284bf104dc8" ، "user_id": "c0add1c9-bede -4224-ab5c-adcf79b0cb66 "،" الرمز ":" USD "،" primary_balance ":" 0.00000000 "،" address ": null،" passphrase ": null،" is_system_wallet ": false،" is_active ": true،" created_at ":" 2020-11-15T10: 35: 46.000000Z "،" updated_at ":" 2020-11-15T10: 35: 46.000000Z "،" on_order_balance ": null،" coin ": {" الرمز ":" USD " ، "الاسم": "الدولار الأمريكي" ، "الرمز": null}}] ، "first_page_url": "http: //trademen.local/api/user/wallets؟ page=1" ، "from": 1 ، "last_page": 1، "last_page_url": "http: //trademen.local/api/user/wallets؟ page=1"، "links": [{"url": null، "label": "& laquo؛ السابق "،" active ": false}، {" url ":" http: //trademen.local/api/user/wallets؟ page=1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" التالي & raquo "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/wallets "،" لكل صفحة ": 15،" prev_page_url ": فارغ،" إلى ": 2،" إجمالي ": 2}}
نموذج استجابة أخطاء الحصول على المحافظ: رمز الحالة - 400
 {"message": "غير مصدق." }

قائمة الإيداع

يرسل طلبًا للحصول على قائمة الإيداع الخاصة بالمستخدم. طريقة GET المطلوبة مع Bearer / Access-Token في طلب HEADER ومعلمة url هي currencySymbol. في حالة نجاحها ، ستعيد الطريقة قائمة الإيداع.

الحصول على نقطة نهاية قائمة الإيداع: https://yourdomain.com/api/user/wallets/{currencySymbol}/deposits

نموذج طلب الإيداع:
 curl -v -X احصل على https://yourdomain.com/api/user/wallets/BTC/deposits \ -H "Content-Type: application / json" \ -H "التفويض : رمز الوصول لحامله 
نموذج لاستجابة قائمة الحصول على الودائع: رمز الحالة - 200
 {"success": true، "data": {"current_page": 1، "data": []، "first_page_url": "http: //trademen.local/api/ مستخدم / محافظ / دولار أمريكي / إيداعات؟ page=1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: //trademen.local/api/user/wallets/USD/deposits؟ page=1 "،" links ": [{" url ": null،" label ":" & laquo؛ Previous "،" active ": false}، {" url ":" http: //trademen.local/api/user/ wallets / USD / إيداع؟ page=1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" Next & raquo؛ "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/wallets/USD/deposits "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total " : 0}
}
نموذج للاستجابة لخطأ قائمة الحصول على الودائع: رمز الحالة - 400
 {"message": "غير مصدق." }

احصل على طرق الدفع المتاحة للنظام

يحصل على طرق الدفع المتاحة للنظام لعملة معينة. طريقة GET المطلوبة ومعلمة url هي رمز العملة. في حالة نجاحها ، ستعرض الطريقة رسالة نجاح وقائمة بطرق الدفع المتاحة والمعلومات المصرفية مع حالة 200 HTTP.

احصل على نقطة نهاية طرق الدفع المتاحة للنظام: https://yourdomain.com/api/coins/{currencySymbol}/payment-methods

نموذج طلب الإيداع:
 curl -v -X احصل على https://yourdomain.com/api/coins/USD/payment-methods \ -H "Content-Type: application / json" 
نموذج الحصول على طرق الدفع المتاحة للنظام استجابة ناجحة: كود الحالة - 200
 {"success": true، "data": {"availablePaymentMethods": {"BankApi": "Bank"}، "selectedSystemBanks": [{"id": "e062682a-6d4f -4809-bad3-0327fc09cc0b "،" country ":" Yemen "،" bankName ":" Graham and Sons "،" iban ":" SE2508297029259183706664 "،" swift ":" BYNLEP58 "،" referenceNumber ":" 953987 "، "accountHolder": "Robbie Kunde V"، "bankAddress": "226 Hildegard Gardens Suite 687 \ nGladysside، WI 89356-4682"، "accountHolderAddress": "578 Tomasa Radial \ nLake Gay، KS 22988"، "isActive": 1 }]}}
نموذج للاستجابة لخطأ قائمة الحصول على الودائع: رمز الحالة - 400
 {"success": false، "message": "لم يتم العثور على البيانات ذات الصلة." }

الحصول على حسابات المستخدم المصرفية

يحصل على حسابات المستخدمين المصرفية. طريقة GET المطلوبة. في حالة نجاحها ، ستعرض الطريقة رسالة نجاح وقائمة بمعلومات الحساب المصرفي للمستخدم مع 200 حالة HTTP.

احصل على نقطة نهاية طرق الدفع المتاحة للنظام: https://yourdomain.com/api/user/bank-accounts

نموذج طلب الحصول على حسابات بنكية للمستخدم:
 curl -v -X احصل على https://yourdomain.com/api/user/bank-accounts \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز الوصول "
نموذج طلب الحصول على حسابات بنكية للمستخدم: كود الحالة - 200
 {"success": true، "data": [{"id": "37d0e460-9813-4fc8-8e6c-7658e5dbd1ba"، "name": "Pagac and Sons"، " iban ":" Pagac and Sons "،" swift ":" QOQLZUKP5JT "،" bankAddress ":" 4463 Jones Burgs \ n Port Lonniefort، OH 75119-9136 "،" referenceNumber ":" 49093775212 "،" accountHolderAddress ":" 64284 Annabel الدورة \ nSouth Joan، MT 89057-3689 "،" isVerified ":" Verified "،" isActive ":" active "،" createdAt ":" 2020-10-27T09: 26: 30.000000Z "}، {" id ": "9a751cd5-a0a4-407c-aa0b-8dbe9b19ebce"، "name": "Haag Inc"، "iban": "Haag Inc"، "swift": "JKGRTU67TMA"، "bankAddress": "1040 Joshua Springs \ nWest Kiaraview، NJ 26021-2701 "،" referenceNumber ":" 7192044944693 "،" accountHolderAddress ":" 88515 Janie Fork \ nWest Brenden، NM 46622 "،" is Verified ":" Verified "،" isActive ":" Active "،" createdAt ": "2020-10-27T09: 26: 30.000000Z"}]} 
نموذج الحصول على استجابة خطأ حسابات المستخدمين المصرفية: كود الحالة - 400
 {"message": "غير مصدق." }

إيداع عملة فيات

إيداع العملات الورقية لمحفظة معينة. طريقة POST والمعلمات المطلوبة هي & ldquo ؛ المبلغ & rdquo ؛ ، & ldquo ؛ api & rdquo ؛ ، & ldquo ؛ bank_account_id & rdquo ؛ (إذا كانت واجهة برمجة التطبيقات / طريقة الدفع هي البنك) ، سياسة الإيداع. في حالة نجاحها ، ستعيد الطريقة رسالة نجاح بحالة HTTP 200 تشتمل على تفاصيل الإيداع وتفاصيل بنك المستخدم وتفاصيل بنك النظام للمستخدم لإرسال المبلغ إلى بنك النظام هذا.

حقل الوصف
المبلغ مطلوب - المبلغ الذي يريد المستخدم إيداعه
واجهة برمجة التطبيقات مطلوب - طرق الدفع المتاحة للعملة المحددة. للحصول على طرق الدفع المتاحة ، راجع الحصول على واجهة برمجة تطبيقات طرق الدفع المتاحة للنظام
معرف_حساب_المصرف مطلوب إذا كانت api / طريقة الدفع هي BANK - معرف الحساب المصرفي للمستخدم الذي يريد الإيداع بواسطته. للحصول على معرف الحساب المصرفي للمستخدم ، راجع الحصول على واجهة برمجة تطبيقات الحسابات المصرفية للمستخدم
سياسة الإيداع مطلوب - القيمة المقبولة هي 1

نقطة نهاية إيداع العملة الورقية: https://yourdomain.com/api/user/wallets/{currencySymbol}/deposits/store

نموذج طلب العملة الورقية للإيداع:
 curl -v -X POST https://yourdomain.com/api/user/wallets/USD/deposits/store \ -H "Content-Type: application / json" \ -H "التفويض: رمز الوصول لحامله" \ -d '{"المبلغ": "200.00000000"، "api": "BankApi"، "bank_account_id": "724200fa-47f2-4e66-b02f-49a2d0f5db47"، "سياسة الإيداع": 1 } '
نموذج استجابة العملة الورقية للإيداع: رمز الحالة - 200
 {"success": true، "message": "تم إنشاء الإيداع بنجاح."، "data": {"DepositDetails": {"id": "a591a65c-6332-49a1 -ae53-e5297726a0ff "،" المستخدم ":" بريت جاكوبسون "،" المحفظة ":" دولار أمريكي (USD) "،" المبلغ ":" 200 "،" bank ":" Pagac and Sons "،" txnId ": فارغة ، "الحالة": "معلقة"} ، "userBankDetail": {"id": "37d0e460-9813-4fc8-8e6c-7658e5dbd1ba" ، "bankName": "Pagac and Sons" ، "bankAddress": "4463 Jones Burgs \ n Port Lonniefort، OH 75119-9136 "،" accountHolder ":" Prof. Axel Ebert "،" referenceNumber ":" 49093775212 "،" swift ":" QOQLZUKP5JT "،" iban ":" LV55ZSQZZ682H91BID460 "،" country ":" ساو تومي وبرينسيبي "،" isActive ":" Active "،" isVerified ":" Verified "}،" DepositWithBanks ": [{" id ":" e062682a-6d4f-4809-bad3-0327fc09cc0b "،" country ":" اليمن "،" bankName ":" Graham and Sons "،" iban ":" SE2508297029259183706664 "،" swift ":" BYNLEP58 "،" referenceNumber ":" 953987 "،" accountHolder ":" Robbie Kunde V "،" bankAddress " : "226 Hildegard Gardens Suite 687 \ nGladysside ، WI 89356-4682 "،" accountHolderAddress ":" 578 ​​Tomasa Radial \ nLake Gay، KS 22988 "،" isActive ":" Active "}]}} 
نموذج للاستجابة لخطأ العملة الورقية للإيداع: رمز الحالة - 400
 {"success": false، "message": "طلب الإيداع الورقي غير صالح." }

تحميل إيصال الإيداع فيات للمراجعة الإدارية

يحمّل إيصال الإيداع المصرفي للمستخدم في بنك النظام. طريقة POST المطلوبة ومعلمات URL هي رمز العملة ومعرف الإيداع وبيانات نموذج الطلب هي & ldquo ؛ system_bank_id & rdquo ؛، & ldquo ؛ الإيصال & rdquo ؛ (ملف صورة). في حالة نجاحها ، ستعيد الطريقة رسالة نجاح بحالة HTTP 200.

نقطة نهاية إيصال الإيداع فيات: https://yourdomain.com/api/user/wallets/{currencySymbol}/deposits/{depositID}/upload-bank-receipt

نموذج طلب إيصال إيداع إيداع نقدي:
 curl -v -X POST https://yourdomain.com/api/user/wallets/USD/deposits/824200fa-47f2-4e66-b02f-49a2d0f5db47/upload-bank-receipt \ -H "Content-Type: multipart / form-data" \ -H "التفويض: وصول الحامل- رمز" \ -F "system_bank_id = 824200fa-47f2-4e66-b02f-49a2d0f5db47" \ -F "إيصال = @ / home / user1 / Desktop / signature.jpg "
نموذج استجابة إيصال الإيداع فيات: كود الحالة - 200
 {"success": true، "message": "تم تحميل الإيصال بنجاح." } 
نموذج استجابة خطأ إيصال إيداع Fiat: رمز الحالة - 400
 {"success": false، "message": "فشل تحميل الإيصال." }

الحصول على عنوان إيداع محفظة التشفير

الحصول على عنوان إيداع المحفظة للعملات المشفرة أو المحفظة المشفرة. طريقة GET المطلوبة ومعلمة url هي رمز العملة المشفرة. إذا نجحت هذه الطريقة ، فستعيد عنوان المحفظة و qrcode مع 200 حالة HTTP.

احصل على نقطة نهاية عنوان إيداع المحفظة المشفرة: https://yourdomain.com/api/user/wallets/{currencySymbol}/get-deposit-address

نموذج طلب عنوان إيداع محفظة التشفير:
 curl -v -X احصل على https://yourdomain.com/api/user/wallets/BTC/get-deposit-address \ -H "Content-Type: application / json" \ -H "التفويض: رمز الوصول لحامله"
نموذج الحصول على استجابة عنوان إيداع المحفظة المشفرة: رمز الحالة - 200
 {"success": true، "data": {"walletAddress": "0x7d0e46098134fc88e6c7658e5dbd1ba"، "qrCode": ...}} 
نموذج الحصول على استجابة خطأ عنوان الإيداع في محفظة التشفير: رمز الحالة - 400
 {"success": false، "message": "خطأ في الشبكة! تعذر إنشاء العنوان." }

الحصول على قائمة الطلبات

يحصل على كل قائمة الطلبات الخاصة بالمستخدم. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. في حالة نجاحها ، ستعيد الطريقة قائمة الطلبات مع 200 حالة HTTP.

احصل على نقطة نهاية الطلب: https://yourdomain.com/api/user/orders

نموذج طلب الحصول على طلب:
 curl -v -X احصل على https://yourdomain.com/api/user/orders \ -H "Content-Type: application / json" \ -H "التفويض: وصول الحامل- رمز "
نموذج لاستجابة قائمة الحصول على الطلبات: رمز الحالة - 200
 {"success": true، "data": {"all_orders": {"current_page": 1، "data": []، "first_page_url": "http: // trademen .local / api / user / orders؟ page = 1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: //trademen.local/api/user/orders؟ page = 1 "، "الروابط": [{"url": null، "label": "& laquo؛ Previous"، "active": false}، {"url": "http: //trademen.local/api/user/orders؟ صفحة = 1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" Next & raquo؛ "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/orders "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total ": 0}}} 
نموذج استجابة أخطاء الحصول على الطلبات: رمز الحالة - 400
 {"message": "غير مصدق." }

الحصول على قائمة الطلبات المفتوحة

احصل على جميع الطلبات المفتوحة لعملة أو سوق معين. طريقة GET المطلوبة ومعلمة URL المطلوبة هي رمز العملة. في حالة نجاحها ، ستعيد الطريقة قائمة الطلبات المفتوحة مع 200 HTTP.

احصل على نقطة نهاية الطلب: https://yourdomain.com/api/user/orders/{coinPair}/open

نموذج طلب الحصول على أوامر مفتوحة:
 curl -v -X احصل على https://yourdomain.com/api/user/orders/BTC_USD/open \ -H "Content-Type: application / json" \ -H "التفويض : رمز وصول لحامله "
نموذج لاستجابة الطلبات المفتوحة: رمز الحالة - 200
 {"success": true، "data": {"open_orders": []}} 
نموذج استجابة خطأ الحصول على الطلبات المفتوحة: رمز الحالة - 400
 {"message": "غير مصدق." }

تقديم الطلب

يضع أمر بيع أو شراء لفئة (حد ، إيقاف ، سوق) في سوق معين. طريقة POST المطلوبة والمعلمات هي "نوع_الطلب" ، "فئة" ، "زوج التجارة" ، "السعر" ، "المبلغ" و "توقف". في حالة نجاحها ، ستعيد الطريقة رقم الطلب

فتاه
حقل الوصف
نوع_الطلب مطلوب - أنواع الأوامر المتاحة هي الشراء والبيع.
فئة مطلوب - الفئات المتاحة هي Limit، stop_limt، market.
trade_pair مطلوب - زوج مثل BTC_USD
السعر مطلوبة إذا لم تكن فئة الطلب سوقًا - رقمية بين 0.000000001 و 999999999.99999999
المبلغ مطلوب إذا كانت فئة الطلب ليست سوقًا ونوع الأمر ليس بيعًا - رقمي بين 0.000000001 و 999999999.99999999
الإجمالي مطلوب إذا كانت فئة الطلب ليست سوقًا ونوع الأمر ليس بيعًا - رقمي بين 0.000000001 و 999999999.99999999
توقف مطلوب إذا كانت فئة الطلب stop_limit - رقم بين 0.000000001 و 999999999999999999

نقطة نهاية الطلب: https://yourdomain.com/api/user/orders/place

نموذج طلب حد الطلب:
 curl -v -X POST https://yourdomain.com/api/user/orders/place \ -H "نوع المحتوى: application / json" \ -H "التفويض: الحامل رمز الوصول "\ -d '{" order_type ":" sell "،" category ":" limit "،" trade_pair ":" BTC_USD "،" price ":" 7500.00000000 "،" amount ":" 0.5 "،" إجمالي ":" 3750.00000000 "،}"
استجابة ناجحة للطلب المحدد بحدود: كود الحالة - 201
 {"success": true، "message": "تم تقديم طلبك بنجاح."، "data": {"order_id": "624200fa-47f2-4e66-b02f-49a2d0f5db47 "،" order_type ":" sale "،" price ":" 7500.00000000 "،" amount ":" 0.50000000 "،" total ":" 3750.00000000 "،" open_amount ":" 0.50000000 "،" exchanged ":" 0 "، "stop_limit": null، "date": "2020-05-21 22:00:00"، "category": "limit"}} 

نموذج طلب السوق:
 curl -v -X POST https://yourdomain.com/api/user/orders/place \ -H "نوع المحتوى: application / json" \ -H "التفويض: الحامل رمز الوصول "\ -d '{" order_type ":" buy "،" category ":" market "،" trade_pair ":" BTC_USD "،" amount ":" 0.5 "}'
نموذج استجابة ناجحة لطلب السوق: رمز الحالة - 201
 {"success": true، "message": "تم تقديم طلبك بنجاح."، "data": {"order_id": "624200fa-47f2-4e66-b02f-49a2d0f5db47 "،" order_type ":" buy "،" price ":" 0 "،" amount ":" 0.50000000 "،" total ":" 0 "،" open_amount ":" 0.50000000 "،" exchanged ":" 0 "، "stop_limit": null، "date": "2020-05-21 22:00:00"، "category": "market"}}

نموذج طلب حد الإيقاف المحدد:
 curl -v -X POST https://yourdomain.com/api/user/orders/place \ -H "نوع المحتوى: application / json" \ -H "التفويض: الحامل رمز الوصول "\ -d '{" order_type ":" buy "،" category ":" stop_limit "،" trade_pair ":" BTC_USD "،" price ":" 7500.00000000 "،" amount ":" 0.5 "،" إجمالي ":" 3750.00000000 "،" توقف ":" 7600.00000000 "} '
استجابة ناجحة لطلب حد الإيقاف: رمز الحالة - 201
 {"success": true، "message": "تم تقديم طلبك بنجاح."، "data": {"order_id": "624200fa-47f2-4e66-b02f-49a2d0f5db47 "،" order_type ":" buy "،" price ":" 7500.00000000 "،" amount ":" 0.50000000 "،" total ":" 3750.00000000 "،" open_amount ":" 0.50000000 "،" exchanged ":" 0 "، "stop_limit": "7600.00000000"، "date": "2020-05-21 22:00:00"، "category": "stop_limit"}} 
نموذج استجابة الخطأ: رمز الحالة - 400
 {"message": "غير مصدق." }

إلغاء الطلب

يضع طلبًا لإلغاء (شراء وبيع) طلب لأي فئة (حد ، حد إيقاف ، سوق) في سوق معين. طريقة DELETE المطلوبة ومعلمة URL المطلوبة هي معرف الطلب. في حالة نجاحها ، ستعيد الطريقة رسالة نجاح بحالة HTTP 200.

إلغاء نقطة نهاية الطلب: https://yourdomain.com/api/user/orders/{orderID}/destroy

نموذج طلب إلغاء الطلب:
 curl -v -X DELETE https://yourdomain.com/api/user/orders/624200fa-47f2-4e66-b02f-49a2d0f5db47/destroy \ -H "نوع المحتوى: تطبيق / json "\ -H" التفويض: رمز وصول الحامل "
نموذج استجابة ناجحة لإلغاء الطلبات: رمز الحالة - 200
 {"success": true، "message": "تم تقديم طلب إلغاء الطلب بنجاح." } 
نموذج استجابة أخطاء الحصول على الطلبات: رمز الحالة - 400
 {"success": false، "message": "تم تقديم طلب إلغاء الطلب بنجاح." }

الحصول على سجل التجارة

يرسل طلبًا للحصول على تاريخ التجارة. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. لو بنجاح ، ستعيد الطريقة تاريخ التجارة.

احصل على نقطة نهاية تاريخ التجارة: https://yourdomain.com/api/user/trade-history

نموذج طلب الحصول على تاريخ التجارة:
 curl -v -X احصل على https://yourdomain.com/api/user/trade-history \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز وصول"
نموذج الحصول على استجابة ناجحة لسجل التجارة: رمز الحالة - 200
 {"success": true، "data": {"trade_history": {"current_page": 1، "data": []، "first_page_url": "http: // trademen .local / api / user / trade-history؟ page = 1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: //trademen.local/api/user/trade-history؟ صفحة = 1 "،" links ": [{" url ": null،" label ":" & laquo؛ Previous "،" active ": false}، {" url ":" http: //trademen.local/api/user / trade-history؟ page = 1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" التالي & raquo؛ "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/trade-history "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total ": 0} }} 
نموذج لاستجابة خطأ سجل التجارة: كود الحالة - 400
 {"message": "غير مصدق." }

الحصول على قائمة السحب

يرسل طلبًا للحصول على قائمة سحب لمحفظة / عملة معينة. طريقة GET المطلوبة وعنوان URL المطلوب المعلمة هي رمز العملة. في حالة نجاحها ، ستعيد الطريقة قائمة رسائل السحب مع 200 HTTP

احصل على نقطة نهاية قائمة السحب: https://yourdomain.com/api/user/wallets/{currencySymbol}/withdrawals

نموذج طلب قائمة السحب:
 curl -v -X احصل على https://yourdomain.com/api/user/wallets/USD/withdrawals \ -H "Content-Type: application / json" \ -H "التفويض : رمز وصول لحامله "
نموذج الحصول على قائمة السحب استجابة ناجحة: كود الحالة - 200
 {"success": true، "data": {"current_page": 1، "data": [{"id": "086aa961-41aa-403e-a2de-5c5b9f78115e"، "user_id": "658532d7-3aa2-4e3c-bb30-4d2b60a61440"، "wallet_id": "ec048965-2206-4680-9b11-8aaba17ca9fc"، "bank_account_id": "37d0e460-9813-4fc8-8e6c-7658e" ":" USD "،" address ": null،" amount ":" 1443.49232849 "،" system_fee ":" 28.86984656 "،" txn_id ":" 5d04d0ae-5f31-4d9e-b3a6-15499d72cfa8 "،" api ":" BankApi "،" status ":" complete "،" created_at ":" 2020-10-13T17: 44: 01.000000Z "،" updated_at ":" 2020-10-04T00: 01: 52.000000Z "،" bank_account ": {" id ":" 37d0e460-9813-4fc8-8e6c-7658e5dbd1ba "،" user_id ":" 658532d7-3aa2-4e3c-bb30-4d2b60a61440 "،" country_id ": 190،" bank_name ":" Pagac and Sons "،" iban " : "LV55ZSQZZ682H91BID460"، "swift": "QOQLZUKP5JT"، "reference_number": "49093775212"، "account_holder": "Prof. Axel Ebert"، "bank_address": "4463 Jones Burgs \ nPort Lonniefort،" OH 75119-9133 "account_holder_address": "64284 Annabel Course \ n South Joan، MT 89057- 3689 "،" is_verified ": 1،" is_active ": 1،" created_at ":" 2020-10-27T09: 26: 30.000000Z "،" updated_at ":" 2020-10-27T09: 26: 30.000000Z "}} ، ...]، "first_page_url": "http: //trademen.local/api/user/wallets/USD/withdrawals؟ page = 1"، "from": 1، "last_page": 1، "last_page_url": "http: //trademen.local/api/user/wallets/USD/withdrawals؟ page = 1"، "links": [{"url": null، "label": "& laquo؛ السابق "،" active ": false}، {" url ":" http: //trademen.local/api/user/wallets/USD/withdrawals؟ page = 1 "،" label ": 1،" active ": true }، {"url": null، "label": "التالي & raquo؛"، "active": false}]، "next_page_url": null، "path": "http: //trademen.local/api/user/ محافظ / دولار أمريكي / عمليات سحب "،" لكل صفحة ": 15،" prev_page_url ": فارغة،" إلى ": 4،" إجمالي ": 4}} 
نموذج لاستجابة خطأ قائمة السحب: كود الحالة - 400
 {"message": "غير مصدق." }

سحب الرصيد

طلب سحب الأماكن لمحفظة / عملة معينة. طريقة POST المطلوبة ومعلمة URL المطلوبة هي رمز العملة وبيانات نموذج الطلب هما "المبلغ" ، "سياسة السحب" ، "العنوان" (مطلوب إذا كانت العملة مشفرة) ، & ldquo ؛ api & rdquo ؛ (مطلوب إذا كانت العملة فيات) ، “bank_account_id & rdquo ؛ (مطلوب معرف حساب المستخدم المصرفي إذا كانت قيمة API هي البنك). إذا نجحت ، ستعيد الطريقة أ رسالة نجاح مع 200 HTTP.

حقل الوصف
المبلغ مطلوب - المبلغ الذي يريد المستخدم سحبه / td & gt؛
سياسة السحب مطلوب - القيمة المقبولة هي 1
العنوان مطلوبة إذا كانت العملة مشفرة - عنوان محفظة التشفير ذي الصلة التي تتلقى مبلغ السحب
واجهة برمجة التطبيقات مطلوبة إذا كانت العملة الورقية - طرق الدفع المتاحة للعملة المحددة. للحصول على طرق الدفع المتاحة ، انظر احصل على طرق الدفع المتاحة للنظام API

طلب سحب نقطة نهاية محفظة التشفير: https://yourdomain.com/api/user/wallets/{CurrencySymbol}/withdrawals

نموذج طلب سحب لمحفظة التشفير:
 curl -v -X POST https://yourdomain.com/api/user/wallets/BTC/withdrawals/store \ -H "Content-Type: application / json" \ -H "التفويض: رمز الوصول للحامل" \ -d '{"amount": "0.50000000"، "pull_policy": 1، "address": "0x24200fa47f24e66b02f49a2d0f5db47"}' 
نموذج طلب سحب لمحفظة فيات:
 curl -v -X POST https://yourdomain.com/api/user/wallets/USD/withdrawals/store \ -H "Content-Type: application / json" \ -H "التفويض: رمز الوصول لحامله" \ -d '{"المبلغ": "0.50000000"، "pull_policy": 1، "api": "BankApi"، "bank_account_id": "724200fa-47f2-4e66-b02f-49a2d0f5db47" } '
نموذج استجابة سحب الرصيد: كود الحالة - 200
 {"success": true، "message": "تم إجراء عملية السحب بنجاح." } 
نموذج استجابة خطأ في سحب الرصيد: كود الحالة - 400
 {"success": false، "message": "تعذر سحب المبلغ." }

إلغاء طلب سحب البنك

يضع طلب إلغاء سحب مصرفي للعملات الورقية. طريقة الحذف المطلوبة وعنوان url المطلوب المعلمة هي رمز العملة ومعرف السحب. إذا نجحت ، ستعيد الطريقة رسالة نجاح مع 200 حالة HTTP.

طلب سحب لنقطة نهاية محفظة التشفير: https://yourdomain.com/api/user/wallets/{CurrencySymbol}/withdrawals/destroy

نموذج طلب سحب بنكي لإلغاء:
 curl -v -X حذف https://yourdomain.com/api/user/wallets/USD/withdrawals/624200fa-47f2-4e66-b02f-49a2d0f5db47/destroy \ -H "المحتوى -النوع: application / json "\ -H" التفويض: رمز وصول الحامل "
نموذج إلغاء طلب سحب البنك استجابة ناجحة: كود الحالة - 200
 {"success": true، "message": "ستتم معالجة إلغاء السحب قريبًا." } 
نموذج إلغاء طلب السحب استجابة خطأ: كود الحالة - 400
 {"success": false، "message": "فشل إلغاء السحب." }

الحصول على أرباح الإحالة

يرسل طلبًا للحصول على أرباح الإحالة. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. لو بنجاح ، ستعرض الطريقة أرباح الإحالة.

احصل على نقطة نهاية لأرباح الإحالة: https://yourdomain.com/api/user/referral/earnings

نموذج طلب الحصول على أرباح إحالة:
 curl -v -X احصل على https://yourdomain.com/api/user/referral/earnings \ -H "نوع المحتوى: application / json" \ -H "التفويض: الحامل رمز الوصول "
نموذج الحصول على استجابة ناجحة لسجل التجارة: رمز الحالة - 200
 {"success": true، "data": {"calling_earnings": {"current_page": 1، "data": []، "first_page_url": "http: // trademen .local / api / user / الإحالة / الأرباح؟ page = 1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: //trademen.local/api/user/referral/earnings؟ صفحة = 1 "،" links ": [{" url ": null،" label ":" & laquo؛ Previous "،" active ": false}، {" url ":" http: //trademen.local/api/user / إحالة / مكاسب؟ page = 1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" التالي & raquo؛ "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/referral/earnings "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total ": 0} }} 
نموذج لاستجابة خطأ سجل التجارة: كود الحالة - 400
 {"message": "غير مصدق." }

الحصول على مستخدمين محالين

يرسل طلبًا للحصول على مستخدمين محالين. طريقة GET المطلوبة مع رمز الحامل / رمز الوصول في طلب HEADER. لو بنجاح ، ستعيد الطريقة قائمة مستخدمي الإحالة.

احصل على نقطة نهاية لمستخدمي الإحالة: https://yourdomain.com/api/user/referral/users

نموذج طلب الحصول على أرباح إحالة:
 curl -v -X احصل على https://yourdomain.com/api/user/referral/users \ -H "Content-Type: application / json" \ -H "التفويض: الحامل رمز الوصول "
نموذج الحصول على استجابة ناجحة من المستخدمين المحالين: كود الحالة - 200
 {"success": true، "data": {"calling_users": {"current_page": 1، "data": []، "first_page_url": "http: // trademen .local / api / user / الإحالة / المستخدمين؟ page = 1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: //trademen.local/api/user/referral/users؟ = 1 "،" links ": [{" url ": null،" label ":" & laquo؛ Previous "،" active ": false}، {" url ":" http: //trademen.local/api/user / الإحالة / المستخدمين؟ page = 1 "،" label ": 1،" active ": true}، {" url ": null،" label ":" التالي & raquo؛ "،" active ": false}]،" next_page_url ": null،" path ":" http: //trademen.local/api/user/referral/users "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total ": 0} }} 
نموذج لاستجابة خطأ المستخدمين المُحالين: كود الحالة - 400
 {"message": "غير مصدق." }

الحصول على أرباح الإحالة من خلال المستخدم

يرسل طلبًا للحصول على أرباح الإحالة من خلال المستخدم. طريقة GET المطلوبة مع Bearer / Access-Token في HEADER الطلب ومعلمة url هي معرف المستخدم. في حالة نجاحها ، ستعيد الطريقة الأرباح من خلال هذا المستخدم.

احصل على نقطة نهاية لمستخدمي الإحالة: https://yourdomain.com/api/user/referral/users/{userID}/earnings

نموذج للحصول على أرباح الإحالة من خلال طلب المستخدم:
 curl -v -X احصل على https://yourdomain.com/api/user/referral/users/{userID}/earnings \ -H "Content-Type: application / json" \ -H "التفويض: رمز الوصول لحامله"
نموذج للحصول على أرباح الإحالة من خلال استجابة المستخدم الناجحة: كود الحالة - 200
 {"success": true، "data": {"earns_through_user": {"current_page": 1، "data": []، "first_page_url": "http: // trademen .local / api / user / الإحالة / المستخدمين / c0add1c9-bede-4224-ab5c-adcf79b0cb66 / الأرباح؟ page = 1 "،" from ": null،" last_page ": 1،" last_page_url ":" http: // trademen .local / api / user / الإحالة / المستخدمين / c0add1c9-bede-4224-ab5c-adcf79b0cb66 / الأرباح؟ page = 1 "،" links ": [{" url ": null،" label ":" & laquo؛ السابق "، "active": false}، {"url": "http: //trademen.local/api/user/referral/users/c0add1c9-bede-4224-ab5c-adcf79b0cb66/earnings؟ page = 1"، "label": 1، "active": true}، {"url": null، "label": "Next & raquo؛"، "active": false}]، "next_page_url": null، "path": "http: // trademen .local / api / user / الإحالة / المستخدمين / c0add1c9-bede-4224-ab5c-adcf79b0cb66 / الأرباح "،" per_page ": 15،" prev_page_url ": null،" to ": null،" total ": 0}}} 
نموذج للحصول على أرباح الإحالة من خلال استجابة خطأ المستخدم: كود الحالة - 400
 {"message": "غير مصدق." }